chore(dropzone): storybook docs and consumer migration guide#6516
chore(dropzone): storybook docs and consumer migration guide#6516cdransf wants to merge 3 commits into
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 |
Coverage Report for CI Build 29454575226Warning No base build found for commit Coverage: 96.257%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsRequires a base build to compare against. How to fix this → Coverage Stats💛 - Coveralls |
512087d to
8426098
Compare
|
| }, | ||
| // design: { type: 'figma', url: 'https://www.figma.com/...' }, | ||
| // stackblitz: { url: 'https://stackblitz.com/...' }, | ||
| design: { |
There was a problem hiding this comment.
Removing this as we decided to omit Figma links for the time being. ✨
| * @type {'copy' | 'move' | 'link' | 'none'} | ||
| * @default 'copy' | ||
| */ | ||
| @property({ type: String, attribute: 'drop-effect' }) |
There was a problem hiding this comment.
dropEffect had no @property decorator, so drop-effect="..." in markup was a silent no-op (1st-gen had the same gap). The attribute's live at parse and run-time now. Also added test coverage and updated the api table. ✨
854bee5 to
86bf09b
Compare
54829a6 to
5a49cde
Compare
86bf09b to
7ec7465
Compare
5a49cde to
74bd0c5
Compare
7ec7465 to
f2931a8
Compare
74bd0c5 to
11f8b39
Compare
f2931a8 to
6235feb
Compare
11f8b39 to
d6cc109
Compare
Description
Adds the remaining Phase 7 documentation deliverables for the Dropzone 2nd-gen migration: the per-component Storybook docs page, the
BehaviorsandAccessibilitystories, and a dedicated consumer migration guide describing how to move from<sp-dropzone>to<swc-dropzone>.2nd-gen/packages/swc/components/dropzone/dropzone.mdx: new per-component docs page covering Anatomy, Options (sizes), States, Behaviors (event log, browse-and-drop), Accessibility, and Upcoming features.2nd-gen/packages/swc/components/dropzone/stories/dropzone.stories.ts: adds theEventLog,BrowseAndDrop, andAccessibilitystories; wires up Figma and Stackblitz links in story metadata; drops the staleautodocstag now that the MDX page exists; adds a "Replace file" control to the filled-state examples so a control stays reachable by keyboard after a file is accepted.2nd-gen/packages/swc/components/dropzone/Dropzone.ts: adds a missing@cssproptag for--swc-illustrated-message-illustration-color, found during the@csspropcompleteness review.2nd-gen/packages/swc/components/dropzone/migration-guide.mdx: new consumer-facing migration guide covering thesp-→swc-tag rename,isDragged/isFilled→dragged/filledproperty renames, event renames (including theswc-dropzone-dragleavedetail shape change), thefilled-contentslot behavior change, the now-required accessible name, and the--mod-*→--swc-*CSS custom property changes.CONTRIBUTOR-DOCS/03_project-planning/03_components/dropzone/migration-plan.md: Documentation phase checklist items checked off to reflect completed work.CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/01_status.md: status table updated for Dropzone.Motivation and context
Dropzone is not considered production-ready without Storybook documentation that captures the necessary 1st-gen content and a migration guide that gives application developers a clear, verified upgrade path. This PR closes both open documentation gaps identified in the ticket.
Related issue(s)
Screenshots (if appropriate)
N/A — documentation-only change. New stories and docs pages are visible under Drop Zone in Storybook (
Behaviors,Accessibility) and under Drop Zone / Migration guide.Author's checklist
Reviewer's checklist
patch,minor, ormajorfeaturesManual review test cases
Storybook docs page renders correctly
<Canvas>blocks to render the correct storyNew Behaviors stories work as documented
swc-dropzone-dragoverfollowed byswc-dropzone-dropMigration guide is accurate
<sp-dropzone>usageDevice review
Accessibility testing checklist
Keyboard (required — document steps below)
<swc-dropzone>host itself (it has notabindex)Screen reader (required — document steps below)