Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UI: Update ScrollArea with radix #24413

Merged
merged 6 commits into from
Oct 10, 2023
Merged

UI: Update ScrollArea with radix #24413

merged 6 commits into from
Oct 10, 2023

Conversation

cdedreuille
Copy link
Contributor

What I did

In this PR we are improving the underlying ScrollArea component to move from overlayscrollbars to @radix-ui/react-scroll-area. The API is much easier to use, resulting in less code to maintain and it is up to the latest standards in term of accessibility.

This is using the exact same API as before and should have not impact on the UI as it is an absolute object position on top of everything.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. To test it, please run Storybook UI locally
  2. Scroll vertically on the sidebar
  3. Alternatively, go to this story to test it out: http://localhost:6006/?path=/story/components-scrollarea--vertical

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@socket-security
Copy link

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Packages Version New capabilities Transitives Size Publisher
@radix-ui/react-scroll-area 1.0.5 None +2 336 kB benoitgrelard

🚮 Removed packages: overlayscrollbars@2.2.1, overlayscrollbars-react@0.5.2

@cdedreuille
Copy link
Contributor Author

@ndelangen @valentinpalkovic Sorry I had to create a new PR. Any chance you could review this one again?

@ndelangen I'm using the same styles as the next version. theme.textMutedColor with opacity of 0.5. When you hover it goes to 0.6 opacity. But in this version I'm pushing it to 0.8 for better visibility.

This is how it look on the sidebar for example.

273562379-0da2023d-03a3-4846-a3df-f7e49078b22a

@cdedreuille cdedreuille merged commit beeab50 into next Oct 10, 2023
15 checks passed
@cdedreuille cdedreuille deleted the move-scrollarea-to-radix branch October 10, 2023 11:04
@github-actions github-actions bot mentioned this pull request Oct 10, 2023
13 tasks
@yannbf yannbf mentioned this pull request Oct 17, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal maintenance User-facing maintenance tasks ui
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants