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

Blocks: Render colors in the same order as provided #25001

Merged
merged 3 commits into from
Dec 13, 2023

Conversation

kaelig
Copy link
Contributor

@kaelig kaelig commented Nov 27, 2023

Fixes a bug where colors wouldn't always be displayed in the order they were provided.

What I did

Object.keys/Object.values (see screenshot below) don't guarantee maintaining the input order in their output. We're using for..in instead to ensure colors swatches are rendered in the provided order.

object.keys returning a different order from the input

Screenshot 2023-11-27 at 3 11 53 PM

Before: 000 appears at the end

Screenshot 2023-11-27 at 3 09 41 PM

After: 000 comes first (like in the source JSON)

Screenshot 2023-11-27 at 3 10 08 PM

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>

Object.keys/Object.values/Object.entries (see screenshot below) don't guarantee maintaining the output order. We're using `for..in` instead to ensure colors swatches are rendered.
@valentinpalkovic
Copy link
Contributor

@cdedreuille This LGTM! Still, could you take a quick look?

@ndelangen ndelangen changed the title Render colors in the same order as provided Blocks: Render colors in the same order as provided Dec 13, 2023
@ndelangen ndelangen merged commit f013ffe into storybookjs:next Dec 13, 2023
47 of 48 checks passed
@github-actions github-actions bot mentioned this pull request Dec 13, 2023
22 tasks
@kaelig kaelig deleted the patch-6 branch December 18, 2023 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants