Repository navigation
Conversation
Installing @salesforce-ux/design-system-2 doesn't serve node_modules over HTTP, so the old <link> example left components unstyled. Lead with a bundler import, keep a serve-and-link alternative, make Cosmos the default theme, and note the ../../public/ images the 2.264.x package doesn't ship. Follow-up to #3236.
- alpha.2 already published with --tag alpha; alpha.3 made it the default via publishConfig.tag - Not every component became a function component - List the SLDSMenuPicklist alias and the SLDS-prefixed aliases removed alongside each component Follow-up to #3236.
- forms has a nested story and test; drop it from the gap lists - List nested stories the snapshot glob skips - The popper-shape adapter is computeFloatingData in utilities/dialog - VisualPicker already supports non-coverable content - Chromatic builds Storybook; what's missing is a public docs site Follow-up to #3236.
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.
Follow-up to #3236
Additional description
Docs-only follow-up to #3236, which merged before its review feedback was addressed. It covers @interactivellama's review comment and the findings from a second review pass. Each finding was checked against git history and the published tarballs.
README (
docs(readme))<link href="/node_modules/...">only worked in Storybook, which mapsdist/cssto/slds2in.storybook/main.ts. Installing the package doesn't servenode_modulesover HTTP, so anyone copying that example got unstyled components. The section now shows a bundler CSS import first, then a serve-and-link alternative for setups without a bundler.../../public/URLs, and that@salesforce-ux/design-system-22.264.x doesn't ship them. Vite warns and builds anyway. webpack'scss-loaderfails unless itsurloption skips those paths. This gap is upstream, in the SLDS 2 package, and is worth raising with the SLDS team.CHANGELOG (
docs(changelog))--tag alphain the workflow. Chore/update package to use alpha tag #3220 madealphathe package default throughpublishConfig.tag.SLDSMenuPicklistalias and theSLDS-prefixed alias of each removed component. These were checked against the root exports of the 0.10.65 and alpha tarballs.ROADMAP (
docs(roadmap))formshas a nested story and test (forms/input/__docs__/inline,forms/input/__tests__/inline.test.jsx), so it's removed from the no-story and no-test lists.__docs__/*.stories.*skips nested stories, soInlineInputandSearchInputare listed as a P2 gap.computeFloatingDatainutilities/dialog/index.jsx, anddialog-helpers.jsonly consumes its output.coverableprop already exists.Not in this PR: @interactivellama also asked for Cosmos to be the default theme in Storybook. That one is for @Niznikr, so this PR doesn't touch
.storybook/.Next: a
fix:PR to loosen the@salesforce-ux/design-systempeer dependency, which is pinned to2.25.0-alpha.2. That PR will also simplify the README'sERESOLVEtroubleshooting.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. N/A: docs only.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). N/A: docs only.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__. N/A: docs only..d.ts(they're generated by the build); JS consumers rely on them via editor type-acquisition. N/A: docs only.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.