docs(actiongroup): storybook and migration guide - #6581
Conversation
|
📚 Branch Preview Links🔍 Gen1 Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
rise-erpelding
changed the title
2fac06e to
a3f6d15
Compare
4f43ce4 to
38a5be6
Compare
38a5be6 to
78779a5
Compare
Add the A4 truncate/justified additive row, cascade the label -> accessible-label rename that shipped in an earlier fix commit but was never reflected in the plan, and add a Review checklist item to fold the accessibility and rendering analysis docs into this plan once the migration lands.
- Retag Compact/Quiet/Justified from 'behaviors' to 'options': they are
static variants, not conditions-over-time or interaction behaviors,
per the states-vs-behaviors test in stories-format.md.
- Drop 'autodocs' from the Playground story now that the per-component
MDX is the docs page.
- Complete the previously TODO'd Accessibility story: a labeled group
plus an outer role="toolbar" wrapper with two named clusters, to
demonstrate the toolbar composition pattern.
- Replace the Bold/Italic/Underline example throughout: it implies a
pressed/selected state that action-group no longer has (selects and
selected were dropped). Switch to Crop/Rotate/Flip, with Cut/Copy/
Paste reserved for the toolbar composition demo.
- Fix meta title casing ('Action Group' -> 'Action group') and the
broken button-group cross-reference link, both pre-existing.
Author action-group.mdx covering Anatomy, Options (sizes, orientation, quiet, compact, justified, static colors), States, Accessibility, and an Upcoming features note for truncate propagation once swc-action-button ships it (migration plan A4).
Cover the vertical -> orientation and label -> accessible-label renames, the new group-level disabled attribute, and the removal of selects/selected, emphasized, and the --mod-actiongroup-* custom property surface, following the consumer-migration-guide skill template.
Update overview aria-label and button labels after the docs rebase replaced Bold/Italic/Underline with Crop/Rotate/Flip. Keep ToolbarComposition as a !dev fixture for the existing a11y snapshot. Match the toolbar-composition example inside the Accessibility story to the wording already used by the testing branch's dedicated ToolbarComposition fixture (Edit actions: Cut/Copy/Paste; View actions: Zoom in/Zoom out), instead of a second, differently-worded example. Also switch the hardcoded gap to the spacing token used by that fixture.
78779a5 to
57c4f65
Compare
Coverage Report for CI Build 31218004862Warning Build has drifted: This PR's base is out of sync with its target branch, so coverage data may include unrelated changes. Warning No base build found for commit Coverage: 96.248%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsRequires a base build to compare against. How to fix this → Coverage Stats
💛 - Coveralls |
2 participants
Description
Finalizes Phase 7 (Documentation) of the
swc-action-groupmigration:action-group.mdx): Anatomy, Options (sizes, orientation, quiet, compact, justified, static colors), States, Accessibility, and an Upcoming features note.Compact/Quiet/Justifiedfrombehaviorstooptions(they're static variants, not conditions-over-time or interaction behaviors), dropsautodocsfrom the Playground story now that the MDX is the docs page, and completes the previously// TODOAccessibility story with a labeled group plus an outerrole="toolbar"wrapper demonstrating the toolbar composition pattern.swc-action-groupno longer has, sinceselects/selectedwere dropped from the 2nd-gen API.migration-guide.mdx) covering thevertical→orientation,label→accessible-labelrenames, the new group-leveldisabled, and the removal ofselects/selected,emphasized, and--mod-actiongroup-*.label→accessible-labelrename that shipped in an earlier fix commit but was never reflected in the plan, and adds a Review checklist item to fold the accessibility/rendering analysis docs into the plan once the migration lands.titlewas'Action Group'(should be sentence case,'Action group') and the button-group cross-reference link pointed at a nonexistent path.Motivation and context
Phase 6 (testing) is proceeding in a parallel branch. This PR closes out the remaining Documentation checklist items in the migration plan so
swc-action-grouphas a real per-component docs page instead of falling back to the generic template, and so consumers upgrading fromsp-action-grouphave a migration guide.Related issue(s)
Screenshots (if appropriate)
N/A — documentation-only change. No component runtime behavior or visual output changed; new/updated Storybook stories and MDX prose only.
Author's checklist
Reviewer's checklist
patch,minor, ormajorfeaturesManual review test cases
Action group docs page renders correctly
<Canvas>examplesConsumer migration guide renders correctly
Retagged Options stories display correctly
Device review
Accessibility testing checklist
Required: Complete each applicable item and document your testing steps.
Keyboard (required — document steps below)
swc-action-group, Arrow keys never crossing from one named cluster to the other, and a visible focus ring throughoutScreen reader (required — document steps below)
swc-action-groupcluster and the outer toolbar wrapperaccessible-label("Image adjustments" / "Edit"), and the outer wrapper announced as "toolbar, Canvas toolbar"