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

Controls: Truncate long arrays in UI #27370

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

GustavoCostaHenriques
Copy link

Closes #25778

What I did

This pull request addresses an issue within a user interface component that currently allows for the display of long lists. The problem is identified in scenarios where a prop is designed to accept a list of items and a connected story (a specific UI state or example) passes a long
list to this prop.

In this pull request rather than showing the complete list, the control will provide a preview of the list items up to a certain limit, followed by an indication that more items are available.

The following image shows how the list is presented to the user at the moment:

Alt text

The following image shows the new feature implemented:

Alt text

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 storybook in your localhost with the following command:
    • yarn start
  2. Add these lines of code in the line 32 in the Button.stories.ts file in the sandbox>react-vite-default-ts>src>stories directory:
  list: Array(1000)
      .fill(0)
      .map((_, index) => ({
        value: `${index}`,
        name: `Option ${index}`,
        desc: `Description ${index}`,
      })),
  1. Access the docs page in the button example story and test the list section.

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>

Co-authored-by: André Soares <andre.p.soares@tecnico.ulisboa.pt>
Copy link

nx-cloud bot commented May 25, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 4351986. 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.

@shilman shilman changed the title Feat: Implements truncation of long lists within Controls Controls: Truncate long arrays in UI May 27, 2024
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.

None yet

3 participants