Skip to content

GrafanaUI: Mark ScrollContainer as stable and deprecate CustomScrollbar#96331

Merged
ashharrison90 merged 6 commits into
mainfrom
ash/deprecate-custom-scrollbar
Nov 14, 2024
Merged

GrafanaUI: Mark ScrollContainer as stable and deprecate CustomScrollbar#96331
ashharrison90 merged 6 commits into
mainfrom
ash/deprecate-custom-scrollbar

Conversation

@ashharrison90

Copy link
Copy Markdown
Contributor

What is this feature?

  • deprecates CustomScrollbar - ScrollContainer is the replacement
  • adds a story for ScrollContainer
  • adds documentation for ScrollContainer, including how to migrate from CustomScrollbar
  • moves ScrollContainer from unstable to a proper export
  • removes the element prop from ScrollContainer since we never want the wrapper element type to change
  • updates everywhere currently using ScrollContainer to use the new import path

Why do we need this feature?

  • more consistent scrollbars across the product
  • better a11y

Who is this feature for?

  • everyone!

Which issue(s) does this PR fix?:

Fixes #80429

Special notes for your reviewer:

Please check that:

  • It works as expected from a user's perspective.
  • If this is a pre-GA feature, it is behind a feature toggle.
  • The docs are updated, and if this is a notable improvement, it's added to our What's New doc.

@ashharrison90 ashharrison90 added this to the 11.4.x milestone Nov 12, 2024
@ashharrison90 ashharrison90 self-assigned this Nov 12, 2024
@ashharrison90 ashharrison90 requested review from a team as code owners November 12, 2024 15:57
@ashharrison90 ashharrison90 requested a review from a team November 12, 2024 15:57
@ashharrison90 ashharrison90 requested review from a team as code owners November 12, 2024 15:57
@ashharrison90 ashharrison90 requested review from IevaVasiljeva, aangelisc, aarongodin, adamyeats, alyssajoyner, bossinc and drclau and removed request for a team November 12, 2024 15:57
@ashharrison90 ashharrison90 changed the title GrafanaUI: Release ScrollContainer and deprecate CustomScrollbar GrafanaUI: Mark ScrollContainer as stable and deprecate CustomScrollbar Nov 12, 2024
@grafana-pr-automation

grafana-pr-automation Bot commented Nov 12, 2024

Copy link
Copy Markdown
Contributor

⚠️   Possible breaking changes (md version)   ⚠️

grafana-ui

Changes

VizRepeater.componentDidUpdate
/home/runner/work/grafana/grafana/pr/grafana-ui/dist/index.d.ts
-componentDidUpdate(prevProps: Props$E): void;
+componentDidUpdate(prevProps: Props$F): void;


Read our guideline

  • Your pull request merge won't be blocked.

@grafana-pr-automation grafana-pr-automation Bot added the levitate breaking change A label indicating a breaking change and assigned by Levitate. label Nov 12, 2024
@grafana-pr-automation grafana-pr-automation Bot requested a review from a team November 12, 2024 16:04

@tskarhed tskarhed left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Just one thing:

Comment thread packages/grafana-ui/src/components/ScrollContainer/ScrollContainer.mdx Outdated
…iner.mdx

Co-authored-by: Tobias Skarhed <1438972+tskarhed@users.noreply.github.com>
@ashharrison90 ashharrison90 merged commit 1924239 into main Nov 14, 2024
@ashharrison90 ashharrison90 deleted the ash/deprecate-custom-scrollbar branch November 14, 2024 12:06
@zserge zserge modified the milestones: 11.4.x, 11.4.1, 11.4.0 Jan 24, 2025
itsmylife pushed a commit to grafana/grafana-prometheus-datasource that referenced this pull request Apr 16, 2026
…llbar` (grafana/grafana#96331)

* deprecate CustomScrollbar, promote ScrollContainer

* add documentation start

* use the properly exported ScrollContainer

* Update packages/grafana-ui/src/components/ScrollContainer/ScrollContainer.mdx

Co-authored-by: Tobias Skarhed <1438972+tskarhed@users.noreply.github.com>

---------

Co-authored-by: Tobias Skarhed <1438972+tskarhed@users.noreply.github.com>
PoorlyDefinedBehaviour pushed a commit that referenced this pull request May 6, 2026
…llbar` (#96331)

* deprecate CustomScrollbar, promote ScrollContainer

* add documentation start

* use the properly exported ScrollContainer

* Update packages/grafana-ui/src/components/ScrollContainer/ScrollContainer.mdx

Co-authored-by: Tobias Skarhed <1438972+tskarhed@users.noreply.github.com>

---------

Co-authored-by: Tobias Skarhed <1438972+tskarhed@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add to changelog area/explore area/frontend datasource/Azure Azure Monitor Datasource levitate breaking change A label indicating a breaking change and assigned by Levitate. no-backport Skip backport of PR type/chore

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecate CustomScrollbar

6 participants