Organism · draft · v1.0.0 · owner: Site system lead · contract 19 of 20 points (open: figma)
Do and don't
Do: Actual hierarchy
Rendered by atomic-guide.tsOpen example: Atomic layers field guide · Do: Actual hierarchy Use the full-page example to follow page links.
Do: Japanese hierarchy
Rendered by atomic-guide.tsOpen example: Atomic layers field guide · Do: Japanese hierarchy Use the full-page example to follow page links.
Don't: Not an organisation tree
Rendered by atomic-guide.tsOpen example: Atomic layers field guide · Don't: Not an organisation tree Use the full-page example to follow page links.
Don't: Not a mandatory dependency chain
Rendered by atomic-guide.tsOpen example: Atomic layers field guide · Don't: Not a mandatory dependency chain Use the full-page example to follow page links.
Rules
| Rule | Why | Check |
|---|---|---|
| Positive specimens declare their rendered initial state and document language; each registered visual variant has a positive example. | Machine and Library consumers need the same examples without turning declarations into execution evidence. | Automated: tests/unit/v4-example-coverage.test.ts |
| Every row must match a real layer and its example must have that layer in the registry. | The field guide must teach the actual system, not an attractive invented hierarchy. | Automated: tests/unit/site-identity.test.ts |
API
| Prop | Type | Required | Default | What it does |
|---|---|---|---|---|
instanceKey | string | No | "atomic-guide" | Stable specimen ID scope. Use distinct keys for multiple guides in one document; up to 64 letters, digits, hyphens or underscores, beginning with a letter. |
lang | en | ja | No | "en" | Guide language. |
Contract details
The full contract: identity, anatomy, variants, states, tokens, layout, motion, accessibility, content, tests
Identity
| Aspect | Value |
|---|---|
| Id | atomic-guide |
| Layer | Organisms |
| Category | diagram |
| Owner | Site system lead |
| Status | draft |
| Version | 1.0.0 |
| Source | apps/showcase/site/system/organisms/atomic-guide.ts (private repository; the contract and the render function are this one module) |
| Version | Date | Change |
|---|---|---|
| 1.0.0 | 2026-10-27 | Created from the owner-selected V4 direction (D-SITE-019). |
Use when
- Explaining how the website is built from its own system. Why: Every abstract layer has a real, inspectable example.
Do not use when
- Explaining global, regional or product governance layers. Why: Those are organisational scopes, not atomic composition levels.
Anatomy
| Part | What it is |
|---|---|
| root | Ordered list of seven levels |
| level | Layer name, visual composition and actual example link |
| note | Composition does not require every dependency to visit every level |
| dependencies | Actual madeOf edges from the representative elements |
| operatingSequence | Source Signal/Pattern/Decision/Rule/Action model, labelled separately |
Made of: heading, text-link, tokens-component, button, cta-pair, header, hero.
Used in: pages directly.
Variants
| Variant | When | Why |
|---|---|---|
| default | Wherever the page declaration places it. | One shape per job keeps pages predictable. |
States
| State | Rendered or not applicable |
|---|---|
| default | default |
| hover | Interactive links retain their text and visible affordance on hover. |
| focus-visible | Contract links, actual Button/CtaPair specimens, disclosure summaries and scrollable specimen regions take focus in reading order; the outer guide does not take focus. |
| active | Enter activates the focused link; native buttons also accept Space. Parent content does not move. |
| disabled | Not applicable: Atomic guide has nothing to disable. |
| loading | Not applicable: Atomic guide is rendered at build time and is complete when the page loads. |
| empty | Not applicable: Content is generated from registered system definitions and has no empty-list variant. |
| error | Not applicable: Atomic guide shows no data that can fail. |
| current | Not applicable: Atomic guide has no current item. |
| visited | Not applicable: These navigational links keep their semantic colour; browser history does not imply task completion. |
| expanded | Not applicable: Atomic guide does not open or close. |
Tokens
| Part | Token |
|---|---|
| --atomic-guide-preview-min-width | var(--w-text) |
| --atomic-guide-cotton | var(--cotton) |
| --atomic-guide-surface | var(--surface) |
| --atomic-guide-ink | var(--ink) |
| --atomic-guide-ink-muted | var(--ink-2) |
| --atomic-guide-line | var(--line) |
| --atomic-guide-line-strong | var(--line-strong) |
| --atomic-guide-rule | var(--rule-hair) |
| --atomic-guide-gap | var(--space-6) |
| --atomic-guide-gap-small | var(--space-3) |
| --atomic-guide-gap-medium | var(--space-4) |
| --atomic-guide-margin | var(--space-9) |
| --atomic-guide-title | var(--type-h3) |
| --atomic-guide-caption | var(--type-small) |
| --atomic-guide-link | var(--link) |
| --atomic-guide-target | var(--space-11) |
| --atomic-guide-indigo | var(--indigo) |
| --atomic-guide-teal | var(--teal) |
| --atomic-guide-saffron | var(--saffron) |
| --atomic-guide-madder | var(--madder) |
| --atomic-guide-focus | var(--focus) |
| --atomic-guide-focus-width | var(--rule) |
| --atomic-guide-focus-offset | var(--space-2) |
Layout
| Aspect | Value |
|---|---|
| breakpoints | The example spans the guide width up to 600 px. At viewport widths of 700 px and above, the native Hero specimen retains at least --atomic-guide-preview-min-width (720 px through --w-text) inside its own scroll region, matching the tile two-column breakpoint. |
| wrapping | Guide copy wraps. Native Header/Hero specimens may scroll inside their labelled, keyboard-focusable regions; the surrounding page must not overflow horizontally. |
| textExpansion | Japanese and expanded text grow within the guide. Native specimen geometry is preserved with local scrolling rather than smaller type or clipped words. |
Spacing and rhythm
| Aspect | Value |
|---|---|
| internal | --space-6 per layer |
| external | --space-9 |
| rhythm | Seven connected levels in reading order. |
Motion
| Aspect | Value |
|---|---|
| None | No intrinsic element animation. The optional claude-entrance consumer profile may translate below-fold structure once (20px, --dur-weave, --ease-enter, --stagger); reduced motion disables it. This preserved baseline entrance is separate from element playback. |
Runtime and reuse
Render-only element; mount any registered child enhancements separately. Preserve required Site CSS, fonts, responsive and locale rules from nativeElement.
Accessibility passport
| Aspect | Value |
|---|---|
| role | Ordered list of seven composition layers with links and actual component specimens |
| name | Visible layer names and contract-link text |
| keyboard | Tab follows document order; Enter follows links or toggles specimen disclosures. Focus a specimen region to scroll it with arrow/Page keys; its embedded Header/Hero controls remain inert. |
| focus | Links, disclosure summaries and scrollable specimen regions have a visible ring; the outer guide is not a focus stop |
| screenReader | The composition and operating sequence are separately labelled; dependencies are real links, not an inferred compulsory chain |
| contrast | Copy uses system ink/link roles on cloth and surface |
| target | Links use the component target token; embedded controls own their targets |
Content
| Slot | Length | Voice |
|---|---|---|
| example | One actual element | Use the registry's real name and link. |
Good: “Atoms · Button”
Bad: “Signal is an atomic component layer”
Japanese: All layer explanations and examples have Japanese text; contract links open the English library.
Icons and illustrations
None: this element uses no icon or illustration of its own.
Decisions and exceptions
Usage
220 uses across the built pages (measured by npm run site:system).
Tests
| Aspect | Value |
|---|---|
| unit | tests/unit/site-system.test.ts: renders every do and don't example through the registry and checks the classes it owns |
| visual | Not yet: there are no screenshot baselines; the Library page is checked for sideways scroll at 1440 px by tests/site/system.spec.ts |
| a11y | tests/site/system.spec.ts: axe (0 serious or critical) on the element's Library page in light and dark |
| parity | scripts/site/system/check.ts: Library examples are rendered by the same render function the site imports |
Figma
not-yet: The Loom Site Figma library is the last stage of the plan; this element is not mapped yet.