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: New icon library #24433

Merged
merged 42 commits into from
Oct 19, 2023
Merged

UI: New icon library #24433

merged 42 commits into from
Oct 19, 2023

Conversation

cdedreuille
Copy link
Contributor

@cdedreuille cdedreuille commented Oct 11, 2023

What I did

Storybook has a new icon library that is used across our entire set of products available here. In this PR we are replacing the old icon library set in @storybook/components in favour of @storybook/icons.

The transition is made in 2 steps. First in 8.0:

  • Remove all svgs from the Icons and Symbols components.
  • Deprecate the Icons and Symbols components.
  • Add match system to map the list of old props to new components.
  • Import @storybook/icons and use it under the hood on the Icons and Symbols components.
  • Replace all instances of the old Icons and Symbols components in the monorepo.

In 9.0 we will:

  • Remove the Icons component, making use of the full tree-shaking of the new @storybook/icons library.
  • Remove the Symbols component

Todo:

  • Add mention on the MIGRATION.md file
  • Replace all icons
  • Tooltip ListItems -> Replace how icons work

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!

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>

@cdedreuille cdedreuille added ui maintenance User-facing maintenance tasks ci:normal labels Oct 11, 2023
@cdedreuille cdedreuille self-assigned this Oct 11, 2023
@shilman
Copy link
Member

shilman commented Oct 13, 2023

There is a 3% increase in static build size from this change (8.615e6 bytes vs 8.378e6). This is small enough that we can probably disregard it and bring the size down in other ways. cc @ndelangen @JReinhold @vanessayuenn

Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

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

Overall great work!
My comments are only minor things here and there.

code/ui/components/src/components/icon/icon.tsx Outdated Show resolved Hide resolved
code/ui/components/src/components/icon/icon.tsx Outdated Show resolved Hide resolved
code/ui/components/src/components/icon/icon.tsx Outdated Show resolved Hide resolved
code/ui/.storybook/preview.tsx Show resolved Hide resolved
code/ui/manager/src/components/sidebar/TreeNode.tsx Outdated Show resolved Hide resolved
@cdedreuille cdedreuille marked this pull request as ready for review October 13, 2023 08:33
code/ui/components/package.json Outdated Show resolved Hide resolved
code/ui/manager/package.json Outdated Show resolved Hide resolved
@cdedreuille cdedreuille requested a review from yannbf as a code owner October 13, 2023 11:09
@socket-security
Copy link

socket-security bot commented Oct 18, 2023

No top level dependency changes detected. Learn more about Socket for GitHub ↗︎

@cdedreuille cdedreuille merged commit a994219 into release-8-0 Oct 19, 2023
14 checks passed
@cdedreuille cdedreuille deleted the new-icon-library branch October 19, 2023 12:05
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.

4 participants