Repository navigation
Conversation
AccordionPanel set `title={title || (summary as string)}` on the
truncated summary span. `summary` accepts any ReactNode, and the cast
only changes the type, not the value. When a JSX summary is passed
without `title`, React stringifies the element and renders
`title="[object Object]"`.
Fall back to `summary` only when it is a string. A JSX summary now
renders no title unless the `title` prop is given.
Checks that a string summary is used as the title, a JSX summary renders no title, and the `title` prop wins over a JSX summary.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #
Additional description
Symptom
When
AccordionPanelgets a JSXsummaryand notitle, the truncated summary span renderstitle="[object Object]".Hovering the panel heading shows "[object Object]" as the native tooltip.
Root cause
The span used
title={title || (summary as string)}.summaryaccepts any ReactNode, and the cast only changes the type, not the value.React then stringifies the element object into the attribute.
The cast also hid the type error, and every story passes a string summary, so neither typecheck nor the story snapshots caught it.
This is not a regression from #3195. The class component before the rewrite had the same fallback.
Change
summaryis used as the title only when it is a string.A JSX summary now renders no title unless the
titleprop is given. String summaries behave exactly as before, so there is no snapshot change and no breaking change.Tests
Added three cases to
accordion.test.jsx.titleprop wins over a JSX summary.CONTRIBUTOR checklist (do not remove)
Please complete for every pull request.
Green gate — all of these must pass locally (CI runs the same):
npm run lintpasses with 0 errors (npm run lint:fixto auto-fix). Warnings are the tracked gradual-migration backlog; do not add new errors.npm run typecheckis clean (tsc --noEmit).npm test -- --runpasses — this runs both Vitest projects (jsdomunit+ real-browserbrowser) and the story HTML snapshots. If you changed rendered markup on purpose, update snapshots withnpm test -- --run -uand review the diff.npm run buildsucceeds (type-check + Vite library build +.d.ts+ entry shims).Behavior & docs:
components/button/__tests__). New props and bug fixes should get a regression test. Tests that genuinely need a real browser (focus traversal, layout/measurement, canvas) go in a*.browser.test.jsxfile (thebrowserproject); everything else is jsdom.npm run storybook→ http://localhost:6007/. Confirm the story actually renders and behaves (deprecated Storyshots/Karma are gone; there is no separate browser-tests server).onRenderContent/onRenderVisualPicker,iconprops,events), not assumptions — a common source of "component looks broken" reports has been stories authored against the wrong API. Cross-check againstcomponents/<name>/__examples__..d.ts(they're generated by the build); JS consumers rely on them via editor type-acquisition.REVIEWER checklist (do not remove)
CIworkflow: lint, typecheck, test, build). Chromatic visual review, if configured, has been checked.components/__tests__/__snapshots__/story-snapshots.test.jsx.snap).@salesforce/design-system-react/components/<name>and nested paths resolve for ESM, CJS, and types). Removing/renaming a public component or export is a breaking change →feat!:/BREAKING CHANGE:and a major version bump.