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: Add key property to list children in Highlight component #26471

Merged
merged 1 commit into from
Mar 13, 2024

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Mar 13, 2024

Closes #26433

What I did

I have added a unique key property to the children of the Result component so that the unique key missing error doesn't appear anymore. The unique key doesn't use a known unique identifier, because having a unique identifier for the highlighting of search results doesn't exists. The unique key in this case is a mixture of search result index and a count for each item in one highlight.

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

  1. Run yarn task to build all Storybook packages
  2. Run yarn storybook:ui
  3. Search for some components and open your developer console in the browser
  4. The warning "Warning: Each child in a list should have a unique "key" prop." shouldn't occur.

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>

Sorry, something went wrong.

Copy link

nx-cloud bot commented Mar 13, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 55761f8. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@valentinpalkovic valentinpalkovic changed the title Add key property to list children in Highlight component UI: Add key property to list children in Highlight component Mar 13, 2024
@valentinpalkovic valentinpalkovic marked this pull request as ready for review March 13, 2024 13:31
Copy link
Contributor

@cdedreuille cdedreuille left a comment

Choose a reason for hiding this comment

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

LGTM!

@valentinpalkovic valentinpalkovic merged commit be079d3 into next Mar 13, 2024
56 of 63 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/fix-missing-key-field branch March 13, 2024 13:35
@github-actions github-actions bot mentioned this pull request Mar 13, 2024
18 tasks
@valentinpalkovic valentinpalkovic added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Mar 19, 2024
storybook-bot pushed a commit that referenced this pull request Mar 19, 2024
…ield

UI: Add key property to list children in Highlight component
(cherry picked from commit be079d3)
@github-actions github-actions bot mentioned this pull request Mar 19, 2024
11 tasks
storybook-bot pushed a commit that referenced this pull request Mar 19, 2024
…ield

UI: Add key property to list children in Highlight component
(cherry picked from commit be079d3)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Mar 19, 2024
Copy link

@sarvarfx sarvarfx left a comment

Choose a reason for hiding this comment

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

Wow it is beautiful

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch ui: search
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: v8 - Warning: Each child in a list should have a unique "key" prop
3 participants