feat(icons): publish 2nd-gen icon docs and make UI icons deliverable - #6733
Open
caseyisonit wants to merge 1 commit into
Open
caseyisonit wants to merge 1 commit into
caseyisonit wants to merge 1 commit into
Conversation
Phase 6 of the S2 icon work: publish consumer documentation for all three icon surfaces and pivot UI icons from internal-only to deliverable. - Un-internalize the UI icon (swc-ui-icon) and swc-icon frame docs pages and the 1st-gen icon migration guide so they ship in the production Storybook build alongside workflow icons. - Document the custom SVG contract for swc-icon (single <svg>, viewBox, no width/height, currentColor fill). - Reframe UI icons and the frame as deliverable in JSDoc and the ui-icons README. - Remove the internal shared-template catalog (icon/elements); the icon VRT fixtures now slot a workflow icon (Icon_ChevronDown) via unsafeSVG. - Record the UI-icon deliverable pivot in the icon RFC. - Fix declaration builds: move the icons package ambient *.css module declaration into src/, and exclude **/*.vrt.ts from the swc dts build so it no longer fails on the generated custom-elements.json import.
🦋 Changeset detectedLatest commit: 8dd7e4f The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
📚 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 |
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
1 participant
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.
Description
Phase 6 of the Spectrum 2 icon work: publish consumer documentation for all three icon surfaces and pivot UI icons from internal-only to deliverable.
<swc-ui-icon>(chevrons, checkmarks, arrows, and other control internals) ships from@adobe/spectrum-wcwith its own consumer docs page next to workflow icons, instead of being internal-only.<swc-icon>frame has a public docs page describing the contract for a slotted SVG (single<svg>,viewBox, nowidth/height,fill="currentColor").<swc-icon>frame, plus the 1st-gen icon migration guide, now ship in the production Storybook build (previously excluded as.internalpages).icon/elements); the icon VRT fixtures now slot a workflow icon (Icon_ChevronDown) viaunsafeSVG.@adobe/spectrum-wc-iconsambient*.cssmodule declaration intosrc/, and exclude**/*.vrt.tsfrom the swc declaration build so it no longer fails on the generatedcustom-elements.jsonimport.Motivation and context
The audience for these docs is consumers. Previously the UI-icon page, the
<swc-icon>custom-SVG frame page, and the migration guide were all.internaland excluded from the published Storybook build, so a consumer following the published docs could not add a UI icon or a custom SVG icon without further guidance. Design also asked that UI icons be deliverable rather than internal-only.Related issue(s)
Screenshots (if appropriate)
N/A. Documentation and Storybook docs-page changes. Note:
swc-iconVRT baselines will change because the reference fixture icon changed from the removed internal chevron to the workflow ChevronDown.Author's checklist