fix(core): fix dynamicTitle: false not taking effect in the toolbar. #33284
Conversation
|
View your CI Pipeline Execution ↗ for commit b6ac5b3
☁️ Nx Cloud last updated this comment at |
📝 WalkthroughWalkthroughAdds an optional Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
✨ Finishing touches
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used📓 Path-based instructions (5)**/*.{js,jsx,json,html,ts,tsx,mjs}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
**/*.{ts,tsx}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
code/**/*.{ts,tsx,js,jsx,mjs}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
code/**/*.{ts,tsx,js,jsx}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
code/**/*.{js,jsx,json,html,ts,tsx,mjs}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
🧠 Learnings (5)📓 Common learnings📚 Learning: 2025-10-03T07:55:42.639ZApplied to files:
📚 Learning: 2025-11-05T09:37:25.920ZApplied to files:
📚 Learning: 2025-09-18T20:51:06.618ZApplied to files:
📚 Learning: 2025-09-18T20:51:06.618ZApplied to files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
🔇 Additional comments (3)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
code/core/src/components/components/Select/Select.tsx (1)
47-50: Update the comment to reflect conditional behavior.The comment states the label "is replaced by the currently selected option's title" in single-select mode, but with the new
showSelectedLabelprop, this only occurs whenshowSelectedLabelis true.Apply this diff to update the documentation:
/** - * Label for the Select component. In single-select mode, is replaced by the currently selected - * option's title. + * Label for the Select component. In single-select mode, is replaced by the currently selected + * option's title when showSelectedLabel is true. */ children?: React.ReactNode;
🧹 Nitpick comments (1)
code/core/src/components/components/Select/Select.tsx (1)
507-512: Logic correctly implements the intended behavior.The conditional rendering properly controls whether the selected option's title is displayed based on the
showSelectedLabelprop, which solves the reported issue.Optional refinement for edge cases:
The current logic
(showSelectedLabel && selectedOptions[0]?.title) || childrenmight not handle edge cases wheretitleis a falsy value (empty string""or numeric0). If such titles are valid in your domain, consider this more explicit check:- {(showSelectedLabel && selectedOptions[0]?.title) || children} + {showSelectedLabel && selectedOptions[0] ? selectedOptions[0].title : children}This ensures that any selected title (including falsy values) is displayed when
showSelectedLabelis true, rather than falling back tochildren.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
code/core/src/components/components/Select/Select.tsx(3 hunks)code/core/src/toolbar/components/ToolbarMenuSelect.tsx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{js,jsx,json,html,ts,tsx,mjs}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use ESLint and Prettier configurations that are enforced in the codebase
Files:
code/core/src/components/components/Select/Select.tsxcode/core/src/toolbar/components/ToolbarMenuSelect.tsx
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Enable TypeScript strict mode
Files:
code/core/src/components/components/Select/Select.tsxcode/core/src/toolbar/components/ToolbarMenuSelect.tsx
code/**/*.{ts,tsx,js,jsx,mjs}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
code/**/*.{ts,tsx,js,jsx,mjs}: Use server-side logger from 'storybook/internal/node-logger' for Node.js code
Use client-side logger from 'storybook/internal/client-logger' for browser code
Do not use console.log, console.warn, or console.error directly unless in isolated files where importing loggers would significantly increase bundle size
Files:
code/core/src/components/components/Select/Select.tsxcode/core/src/toolbar/components/ToolbarMenuSelect.tsx
code/**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Export functions that need to be tested from their modules
Files:
code/core/src/components/components/Select/Select.tsxcode/core/src/toolbar/components/ToolbarMenuSelect.tsx
code/**/*.{js,jsx,json,html,ts,tsx,mjs}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
code/**/*.{js,jsx,json,html,ts,tsx,mjs}: Run Prettier with --write flag to format code before committing
Run ESLint with yarn lint:js:cmd to check for linting issues and fix errors before committing
Files:
code/core/src/components/components/Select/Select.tsxcode/core/src/toolbar/components/ToolbarMenuSelect.tsx
🧠 Learnings (3)
📓 Common learnings
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/Tabs/Tabs.stories.tsx:222-227
Timestamp: 2025-11-05T09:36:55.944Z
Learning: Repo: storybookjs/storybook PR: 32458 — In code/core/src/components/components/Button/Button.tsx (React/TypeScript), ButtonProps includes ariaLabel?: string | false and the component maps it to the DOM aria-label. Convention: ariaLabel is mandatory on all Button usages — provide a descriptive string for icon-only buttons; set ariaLabel=false when the button’s children already serve as the accessible name. Do not suggest using a raw aria-label prop on Button call sites.
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/Select/Select.tsx:200-204
Timestamp: 2025-11-05T09:38:47.712Z
Learning: Repo: storybookjs/storybook — Guidance: Until Storybook 11 is released, do not suggest using React.useId anywhere (e.g., in code/core/src/components/components/Select/Select.tsx) to maintain compatibility with React 17 runtimes. Prefer advising: accept a caller-provided props.id and, if needed, generate a client-only fallback id to minimize SSR hydration issues — but avoid useId. Resume prompting for useId after Storybook 11.
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/manager/components/preview/Toolbar.tsx:102-105
Timestamp: 2025-10-03T07:55:42.639Z
Learning: In code/core/src/manager/components/preview/Toolbar.tsx, we intentionally do not add aria-label/aria-labelledby to StyledToolbar (AbstractToolbar) because the enclosing section is already labeled via an sr-only heading and the toolbar is the only content. Revisit only if real user testing indicates a need.
📚 Learning: 2025-11-05T09:36:55.944Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/Tabs/Tabs.stories.tsx:222-227
Timestamp: 2025-11-05T09:36:55.944Z
Learning: Repo: storybookjs/storybook PR: 32458 — In code/core/src/components/components/Button/Button.tsx (React/TypeScript), ButtonProps includes ariaLabel?: string | false and the component maps it to the DOM aria-label. Convention: ariaLabel is mandatory on all Button usages — provide a descriptive string for icon-only buttons; set ariaLabel=false when the button’s children already serve as the accessible name. Do not suggest using a raw aria-label prop on Button call sites.
Applied to files:
code/core/src/components/components/Select/Select.tsxcode/core/src/toolbar/components/ToolbarMenuSelect.tsx
📚 Learning: 2025-10-03T07:55:42.639Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/manager/components/preview/Toolbar.tsx:102-105
Timestamp: 2025-10-03T07:55:42.639Z
Learning: In code/core/src/manager/components/preview/Toolbar.tsx, we intentionally do not add aria-label/aria-labelledby to StyledToolbar (AbstractToolbar) because the enclosing section is already labeled via an sr-only heading and the toolbar is the only content. Revisit only if real user testing indicates a need.
Applied to files:
code/core/src/toolbar/components/ToolbarMenuSelect.tsx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: normal
- GitHub Check: nx
- GitHub Check: Core Unit Tests, windows-latest
🔇 Additional comments (3)
code/core/src/components/components/Select/Select.tsx (2)
79-83: LGTM! Clear documentation for the new prop.The
showSelectedLabelprop is well-documented and appropriately optional with a sensible default.
208-208: LGTM! Default parameter correctly maintains backward compatibility.code/core/src/toolbar/components/ToolbarMenuSelect.tsx (1)
104-104: Verify the showSelectedLabel={false} fix for dynamicTitle behavior in issue #33281.Setting
showSelectedLabel={false}should prevent the Select component from replacing the displayed title with the selected option's title whendynamicTitleis false. This appears to be the correct approach to fix the reported issue, with backward compatibility preserved (defaultshowSelectedLabel={true}maintains existing behavior for other Select usages).Manual verification recommended: Test with a toolbar configuration where
dynamicTitle: falseand confirm the toolbar title remains fixed when selecting different options from the dropdown.
| onReset={() => updateGlobals({ [id]: '_reset' })} | ||
| onSelect={(selected) => updateGlobals({ [id]: selected })} | ||
| icon={icon && <Icons icon={icon} __suppressDeprecationWarning={true} />} | ||
| showSelectedLabel={false} |
There was a problem hiding this comment.
| showSelectedLabel={false} | |
| showSelectedLabel={dynamicTitle} |
otherwise it'll never update
| if (dynamicTitle) { | ||
| title = getSelectedTitle({ currentValue, items }) || title; | ||
| } |
There was a problem hiding this comment.
If we pass dynamicTitle through, then we can remove this logic and pass title through directly
There was a problem hiding this comment.
Thanks for pointing that out — updated accordingly.
… unused import, pass dynamicTitle via showSelectedLabel
| /** | ||
| * Whether to show the selected option's title in place of the children when an option is | ||
| * selected. Defaults to true. | ||
| */ | ||
| showSelectedLabel?: boolean; |
There was a problem hiding this comment.
| /** | |
| * Whether to show the selected option's title in place of the children when an option is | |
| * selected. Defaults to true. | |
| */ | |
| showSelectedLabel?: boolean; | |
| /** | |
| * Legacy option for ToolbarMenuSelect. Do not set this prop in new Storybook code. Whether to show the selected option's title or to preserve the Select's title when a selection is made. | |
| * @default true | |
| */ | |
| showSelectedOptionTitle?: boolean; |
Two comments here:
- I truly do not want people to start using this prop because we made an explicit UX choice with @MichaelArestad to always show the selected item; it aligns the component's behaviour more closely with native HTML
select - Let's name it
showSelectedOptionTitlebecause it controls showing the selected option's title; this will help us understand our code better :)
There was a problem hiding this comment.
We'll need new stories showing how labels behave on !multiSelect and on multiSelect Selects, when a selection is made, and the option is on or off (so, 4 stories with defaultOptions and a play function validating the HTML output).
| id, | ||
| name, | ||
| description, | ||
| toolbar: { icon: _icon, items, title: _title, preventDynamicIcon, dynamicTitle }, |
There was a problem hiding this comment.
Could you please make dynamicTitle true by default here?
| const isOverridden = id in storyGlobals; | ||
| let icon = _icon; | ||
| let title = _title; | ||
| const title = _title; |
There was a problem hiding this comment.
You no longer need to rename the title prop to _title and then create a new title. Could you please tidy that up?
There was a problem hiding this comment.
Bunch more things to tidy up:
- In docs/_snippets/storybook-preview-configure-globaltypes.md, could you please replace the 4 occurences of
// Change title based on selected valueto// Change title based on selected value (recommended for consistency with the Storybook UI) - Remove
getSelectedTitle's source code as it is no longer needed
3 participants
Closes #33281
What I did
showSelectedLabelprop toSelect(defaulttrue).showSelectedLabel={false}inToolbarMenuSelect.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.