Skip to content

FAB Menu

A FAB that fans out into 2–6 related actions. Anchors to an existing md-fab by id, morphs that FAB’s icon to close while open, and manages the popup’s ARIA wiring, roving focus and dismissal.

Live preview Open in Storybook
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<md-fab id="create-fab" icon="add" aria-label="Create"></md-fab>

<md-fab-menu anchor="create-fab" placement="up" variant="primary" menu-label="Create">
  <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
  <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
  <md-fab-menu-item icon="slideshow" label="Presentation"></md-fab-menu-item>
</md-fab-menu>

Already installed? See the Installation guide for one-time package setup (core + tokens, fonts). Each tab below shows two patterns for using md-fab-menu in your project: Option A registers every AWC UI component at once (simplest), Option B imports only this component for tree-shake-friendly bundles.

<!-- ─── Option A: global registration (all components) ─── -->
<script type="module">
  import '@awc-ui/core/define';
</script>


<!-- ─── Option B: single import (tree-shake only md-fab-menu) ─── -->
<script type="module">
  import '@awc-ui/core/components/md-fab-menu';
</script>


<md-fab-menu></md-fab-menu>
  • One prominent creation point that branches into 2–6 related actions — new doc / sheet / slide, or photo / video / file.
  • All the branches are positive, creation-flavoured actions of comparable weight.
SituationUse instead
Exactly one primary actionmd-fab alone
More than ~6 actionsmd-menu, or a dedicated screen
Overflow / secondary / destructive actionsmd-menu from an icon button
A screen that already has a toolbar or navigation railmd-menu — M3 says don’t pair them
Options that select a value rather than trigger an actionmd-select

The FAB is your element, referenced by id. The menu renders no trigger of its own.

<md-fab id="create-fab" icon="add" aria-label="Create"></md-fab>
<md-fab-menu anchor="create-fab" placement="up" variant="primary">
<md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
<md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
<md-fab-menu-item icon="slideshow" label="Presentation"></md-fab-menu-item>
</md-fab-menu>

That is the whole contract: two elements joined by one id. The menu can sit anywhere in the document — it positions itself against the anchor’s rect, not against its own parent:

The two elements above, wired by id — press the FAB
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="inline-size:100%;min-block-size:200px;display:grid;place-items:end center;padding-block-end:16px;">
  <md-fab id="fm-struct" icon="add" aria-label="Create"></md-fab>
</div>
<md-fab-menu anchor="fm-struct" placement="up" variant="primary" menu-label="Create">
  <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
  <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
  <md-fab-menu-item icon="slideshow" label="Presentation"></md-fab-menu-item>
</md-fab-menu>
PropValuesNotes
placementup (default) · down · autoauto picks from available viewport space
variantprimary (default) · secondary · tertiaryOpen-state FAB colour and item container tone
quickbooleanSkip the close animation — close() drops straight to open=false instead of holding a 180ms closing state. The opening transition always runs
menu-labelstringAccessible name of the popup — localize it
density0…-4Forwarded to the items
placement — up and down
placement="up"
placement="down"
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="inline-size:100%;display:grid;grid-template-columns:1fr 1fr;gap:24px;">
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">placement="up"</div>
    <div style="inline-size:100%;min-block-size:200px;display:grid;place-items:end center;padding-block-end:16px;">
      <md-fab id="fm-up" icon="add" aria-label="Create"></md-fab>
    </div>
    <md-fab-menu anchor="fm-up" variant="primary" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
      <md-fab-menu-item icon="slideshow" label="Presentation"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">placement="down"</div>
    <div style="inline-size:100%;min-block-size:200px;display:grid;place-items:start center;padding-block-start:16px;">
      <md-fab id="fm-down" icon="add" aria-label="Create"></md-fab>
    </div>
    <md-fab-menu anchor="fm-down" placement="down" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
      <md-fab-menu-item icon="slideshow" label="Presentation"></md-fab-menu-item>
    </md-fab-menu>
  </div>
</div>

variant tints the open-state FAB and the item containers together, so the cluster reads as one object rather than a FAB with unrelated chips:

variant — primary, secondary, tertiary
primary
secondary
tertiary
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="inline-size:100%;display:grid;grid-template-columns:repeat(3,1fr);gap:16px;">
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">primary</div>
    <div style="min-block-size:180px;display:grid;place-items:end center;"><md-fab id="fm-v1" icon="add" aria-label="Primary"></md-fab></div>
    <md-fab-menu anchor="fm-v1" variant="primary" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">secondary</div>
    <div style="min-block-size:180px;display:grid;place-items:end center;"><md-fab id="fm-v2" variant="secondary-container" icon="add" aria-label="Secondary"></md-fab></div>
    <md-fab-menu anchor="fm-v2" variant="secondary" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">tertiary</div>
    <div style="min-block-size:180px;display:grid;place-items:end center;"><md-fab id="fm-v3" variant="tertiary-container" icon="add" aria-label="Tertiary"></md-fab></div>
    <md-fab-menu anchor="fm-v3" variant="tertiary" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
    </md-fab-menu>
  </div>
</div>

While open, the component writes to your FAB:

  • aria-expanded, aria-haspopup="menu" and aria-controls
  • swaps anchorEl.icon to close, restoring the original on close
  • sets data-shape="circle", which applies border-radius: 50% — a squared icon-only FAB goes round. That is the whole rule: on an extended FAB it rounds the pill into an ellipse, it does not collapse the label or the width
  • sets --md-fab-container-color / --md-fab-icon-color from the menu’s variant, and removes them again on close

Don’t set those yourself, and don’t change the anchor’s icon while the menu is open — the component saves and restores it around the morph.

Open either — the surface FAB takes the menu's colour and its edit icon becomes close
variant="primary"
variant="tertiary"
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="inline-size:100%;display:grid;grid-template-columns:1fr 1fr;gap:24px;">
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">variant="primary"</div>
    <div style="min-block-size:190px;display:grid;place-items:end center;"><md-fab id="fm-morph-a" variant="surface" icon="edit" aria-label="Compose"></md-fab></div>
    <md-fab-menu anchor="fm-morph-a" variant="primary" menu-label="Compose">
      <md-fab-menu-item icon="mail" label="Email"></md-fab-menu-item>
      <md-fab-menu-item icon="chat" label="Message"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">variant="tertiary"</div>
    <div style="min-block-size:190px;display:grid;place-items:end center;"><md-fab id="fm-morph-b" variant="surface" icon="edit" aria-label="Compose"></md-fab></div>
    <md-fab-menu anchor="fm-morph-b" variant="tertiary" menu-label="Compose">
      <md-fab-menu-item icon="mail" label="Email"></md-fab-menu-item>
      <md-fab-menu-item icon="chat" label="Message"></md-fab-menu-item>
    </md-fab-menu>
  </div>
</div>

M3 puts the ceiling at six. Past that the fan becomes a list that happens to animate, and a md-menu or a dedicated screen serves the user better:

Two items against the six-item ceiling
2 items — comfortable
6 items — the ceiling
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="inline-size:100%;display:grid;grid-template-columns:1fr 1fr;gap:24px;">
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">2 items — comfortable</div>
    <div style="min-block-size:220px;display:grid;place-items:end center;"><md-fab id="fm-two" icon="add" aria-label="Two"></md-fab></div>
    <md-fab-menu anchor="fm-two" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">6 items — the ceiling</div>
    <div style="min-block-size:220px;display:grid;place-items:end center;"><md-fab id="fm-six" icon="add" aria-label="Six"></md-fab></div>
    <md-fab-menu anchor="fm-six" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
      <md-fab-menu-item icon="slideshow" label="Presentation"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
      <md-fab-menu-item icon="folder" label="Folder"></md-fab-menu-item>
      <md-fab-menu-item icon="link" label="Link"></md-fab-menu-item>
    </md-fab-menu>
  </div>
</div>
EventCancelableDetailFiresFrom
mdOpennovoidMenu openedmd-fab-menu
mdClosenovoidMenu closedmd-fab-menu
mdClicknovoidAn item was pressedmd-fab-menu-item

Methodsshow(), close().

mdClick comes from the item, not the menu, but it bubbles and is composed, so one listener on md-fab-menu hears every item. Its detail is null — there is no e.detail.value to read. Identify the pressed item from e.target, which is the md-fab-menu-item even though you attached the listener to the menu; e.currentTarget is the menu, the element you attached to. Attach per item instead — as the framework snippets below do — and the handler already knows which action it is, which is handier when each is a different function.

All three events reach a listener on the menu. Press the FAB and then an item to watch the full open → click → close sequence, including the null detail:

Open, click an item, and read the event log
Press the FAB, then pick an action.
Show code for each technology
<md-fab id="fab" icon="add" aria-label="Create"></md-fab>

<md-fab-menu id="menu" anchor="fab" placement="up" menu-label="Create">
<md-fab-menu-item icon="edit" label="New note"></md-fab-menu-item>
<md-fab-menu-item icon="photo" label="Upload photo"></md-fab-menu-item>
</md-fab-menu>

<script type="module">
const menu = document.getElementById('menu');

menu.addEventListener('mdOpen', () => console.log('opened'));
menu.addEventListener('mdClose', () => console.log('closed'));

// mdClick comes from the ITEM and bubbles up to the menu.
// The menu closes itself in response — do not call menu.close() here.
menu.addEventListener('mdClick', (e) => {
  create(e.target.label);
});
</script>

Properties

PropertyAttributeTypeDefaultReflects
openopenbooleanfalseYes
anchoranchorstring''
variantvariant'primary' | 'secondary' | 'tertiary''primary'Yes
placementplacement'up' | 'down' | 'auto''up'Yes
quickquickbooleanfalse
menuLabelmenu-labelstring'Actions'
densitydensity0 | -1 | -2 | -3 | -40Yes

Methods

MethodParameters
show()none
close()none

Slots

SlotDescription
(default)

CSS Custom Properties

Override on the host element for per-instance theming:

PropertyDescription
--md-fab-menu-item-container-colorItem background (cascades to children)
--md-fab-menu-item-label-colorItem label + icon color (cascades)
--md-fab-menu-item-gapGap between items (default 4px)
  • The popup is role="menu" with aria-orientation="vertical". Escape closes; ArrowUp/ArrowDown move a roving focus across items.
  • Closing always returns focus to the anchor FAB, however the menu was opened. What is activation-aware is the opening: from the keyboard, or from a click on an already-focused FAB, focus moves onto the first item; a pointer click on an unfocused FAB leaves focus on the anchor and only primes the roving tabindex.
  • The anchor must be a real, focusable control — the component wires aria-expanded/aria-haspopup/aria-controls onto it.
  • M3 requires the open menu not to fully obscure another actionable element or its focus indicator. Verify at your smallest viewport.
  • The closed menu is aria-hidden, so its items are not announced.
Open it, then drive it from the keyboard
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="inline-size:100%;min-block-size:220px;display:grid;place-items:end center;padding-block-end:16px;">
  <md-fab id="fm-kbd" icon="add" aria-label="Create"></md-fab>
</div>
<md-fab-menu anchor="fm-kbd" menu-label="Create something">
  <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
  <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
  <md-fab-menu-item icon="slideshow" label="Presentation"></md-fab-menu-item>
</md-fab-menu>

Open the menu above and use the keyboard: ArrowUp / ArrowDown move through the items, Home / End jump to the ends, typing a letter jumps to the next item whose label starts with it, and Escape closes and returns focus to the FAB. Tab walks forward through the items and dismisses the menu once it passes the last one; Shift+Tab from the first item hands focus back to the FAB — so Tab never strands you in a popup that is still open behind you.

The stack is vertical, so placement never mirrors — up stays up. What does mirror is the edge the cluster hangs from: the menu reads the computed direction and pins itself to the anchor’s trailing edge, so nothing needs re-authoring between directions. See RTL.

<div dir="rtl">
<md-fab id="fab" icon="add" aria-label="إنشاء"></md-fab>
<md-fab-menu anchor="fab" menu-label="إنشاء"></md-fab-menu>
</div>

The same menu in both directions. Only dir and the strings change; the markup and props are identical:

Same markup, dir=ltr vs dir=rtl
ltr
rtl
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="display:grid;grid-template-columns:auto 1fr;gap:14px 16px;align-items:center;">
  <span style="inline-size:3.5rem;opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;">ltr</span>
  <div dir="ltr" style="min-block-size:170px;display:grid;align-items:end;justify-items:end;padding:0 16px 16px;">
    <md-fab id="fm-ltr" icon="add" aria-label="Create"></md-fab>
    <md-fab-menu anchor="fm-ltr" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <span style="inline-size:3.5rem;opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;">rtl</span>
  <div dir="rtl" style="min-block-size:170px;display:grid;align-items:end;justify-items:end;padding:0 16px 16px;">
    <md-fab id="fm-rtl" icon="add" aria-label="إنشاء"></md-fab>
    <md-fab-menu anchor="fm-rtl" menu-label="إنشاء">
      <md-fab-menu-item icon="description" label="مستند"></md-fab-menu-item>
      <md-fab-menu-item icon="table_chart" label="جدول"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="صورة"></md-fab-menu-item>
    </md-fab-menu>
  </div>
</div>

Place the anchor logically, not with right

Section titled “Place the anchor logically, not with right”

The menu follows the FAB wherever the FAB lands, so the one thing that can go wrong is your layout. Pin the anchor with a logical value (justify-items: end, inset-inline-end) and the whole cluster moves corner-to-corner under RTL. Pin it with a physical right and the FAB — and therefore the menu — stays welded to the right edge of an RTL screen:

justify-items: end follows dir; justify-items: right does not
correct
wrong
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="display:grid;grid-template-columns:auto 1fr;gap:14px 16px;align-items:center;">
  <span style="inline-size:3.5rem;opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;">correct</span>
  <div dir="rtl" style="min-block-size:170px;display:grid;align-items:end;justify-items:end;padding:0 16px 16px;border-radius:12px;background:color-mix(in srgb, currentColor 4%, transparent);">
    <md-fab id="fm-ok" icon="add" aria-label="إنشاء"></md-fab>
    <md-fab-menu anchor="fm-ok" menu-label="إنشاء">
      <md-fab-menu-item icon="description" label="مستند"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="صورة"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <span style="inline-size:3.5rem;opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;">wrong</span>
  <div dir="rtl" style="min-block-size:170px;display:grid;align-items:end;justify-items:right;padding:0 16px 16px;border-radius:12px;background:color-mix(in srgb, currentColor 4%, transparent);">
    <md-fab id="fm-bad" icon="add" aria-label="إنشاء"></md-fab>
    <md-fab-menu anchor="fm-bad" menu-label="إنشاء">
      <md-fab-menu-item icon="description" label="مستند"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="صورة"></md-fab-menu-item>
    </md-fab-menu>
  </div>
</div>

density on the menu cascades to its items — set it there, not on each item. It does not reach the anchor FAB: the anchor is resolved by id, is not a descendant of the menu, and the component writes only shape, icon and colour to it. Set density on your md-fab as well when you want the whole cluster on one rung — which is exactly what each pair below does. Open any of these to compare the item heights:

Density 0 through -4 — open one to see the items taper
0
-1
-2
-3
-4
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="inline-size:100%;display:grid;grid-template-columns:repeat(5,1fr);gap:12px;">
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;text-align:center;">0</div>
    <div style="min-block-size:170px;display:grid;place-items:end center;">
      <md-fab id="fm-d0" density="0" icon="add" aria-label="Create at density 0"></md-fab>
    </div>
    <md-fab-menu anchor="fm-d0" density="0" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;text-align:center;">-1</div>
    <div style="min-block-size:170px;display:grid;place-items:end center;">
      <md-fab id="fm-d1" density="-1" icon="add" aria-label="Create at density -1"></md-fab>
    </div>
    <md-fab-menu anchor="fm-d1" density="-1" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;text-align:center;">-2</div>
    <div style="min-block-size:170px;display:grid;place-items:end center;">
      <md-fab id="fm-d2" density="-2" icon="add" aria-label="Create at density -2"></md-fab>
    </div>
    <md-fab-menu anchor="fm-d2" density="-2" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;text-align:center;">-3</div>
    <div style="min-block-size:170px;display:grid;place-items:end center;">
      <md-fab id="fm-d3" density="-3" icon="add" aria-label="Create at density -3"></md-fab>
    </div>
    <md-fab-menu anchor="fm-d3" density="-3" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;text-align:center;">-4</div>
    <div style="min-block-size:170px;display:grid;place-items:end center;">
      <md-fab id="fm-d4" density="-4" icon="add" aria-label="Create at density -4"></md-fab>
    </div>
    <md-fab-menu anchor="fm-d4" density="-4" menu-label="Create">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
    </md-fab-menu>
  </div>
</div>

The two are independent signals, so they compose without any extra wiring — an inherited data-density ancestor and dir="rtl" on the same element:

dir=rtl with an inherited data-density=-3
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div dir="rtl" data-density="-3" style="min-block-size:190px;display:grid;align-items:end;justify-items:end;padding:0 16px 16px;">
  <md-fab id="fm-dd" icon="add" aria-label="إنشاء"></md-fab>
  <md-fab-menu anchor="fm-dd" menu-label="إنشاء">
    <md-fab-menu-item icon="description" label="مستند"></md-fab-menu-item>
    <md-fab-menu-item icon="table_chart" label="جدول"></md-fab-menu-item>
    <md-fab-menu-item icon="image" label="صورة"></md-fab-menu-item>
  </md-fab-menu>
</div>

Densitydensity="-1…-4" on the menu locally overrides the inherited data-density rung and cascades to every item. See Density.

i18n — translate the item labels and menu-label, the popup’s accessible name, which is English ("Actions") by default. lang and dir are inherited from any ancestor.

All three are set once on md-fab-menu. The first two inherit down into every item; the third is the menu’s own flex gap and never reaches an item:

Custom propertyPurposeRead byDefault
--md-fab-menu-item-container-colorItem container backgroundeach item*-container per variant
--md-fab-menu-item-label-colorItem label + icon coloureach itemon-*-container per variant
--md-fab-menu-item-gapGap between stacked itemsthe menu itself--md-sys-spacing-gap-xs (4px)
Themed instances
custom colours
wider gap
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="inline-size:100%;display:grid;grid-template-columns:1fr 1fr;gap:24px;">
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">custom colours</div>
    <div style="min-block-size:190px;display:grid;place-items:end center;"><md-fab id="fm-theme1" variant="surface" icon="add" aria-label="Themed"></md-fab></div>
    <md-fab-menu anchor="fm-theme1" menu-label="Create" style="--md-fab-menu-item-container-color: var(--md-sys-color-error); --md-fab-menu-item-label-color: var(--md-sys-color-on-error);">
      <md-fab-menu-item icon="delete" label="Delete"></md-fab-menu-item>
      <md-fab-menu-item icon="report" label="Report"></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">wider gap</div>
    <div style="min-block-size:190px;display:grid;place-items:end center;"><md-fab id="fm-theme2" icon="add" aria-label="Spaced"></md-fab></div>
    <md-fab-menu anchor="fm-theme2" menu-label="Create" style="--md-fab-menu-item-gap: 16px;">
      <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
      <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
    </md-fab-menu>
  </div>
</div>

CSS parts reach inside the item’s shadow root for things custom properties do not cover. md-fab-menu itself exposes none — the parts live on md-fab-menu-item: state-layer, icon and label.

::part(label) and ::part(icon) on the items
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<style>
  .fm-shout md-fab-menu-item::part(label) { text-transform: uppercase; letter-spacing: .08em; font-weight: 600; }
  .fm-shout md-fab-menu-item::part(icon)  { transform: scale(1.25); }
</style>
<div style="inline-size:100%;min-block-size:200px;display:grid;place-items:end center;padding-block-end:16px;">
  <md-fab id="fm-part" variant="tertiary-container" icon="add" aria-label="Create"></md-fab>
</div>
<md-fab-menu class="fm-shout" anchor="fm-part" variant="tertiary" menu-label="Create">
  <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
  <md-fab-menu-item icon="image" label="Image"></md-fab-menu-item>
</md-fab-menu>
md-fab-menu-item::part(label) {
letter-spacing: 0.4px;
}

md-fab-menu-item has no page of its own: it is only ever valid as a direct child of md-fab-menu, which owns opening, roving focus and dismissal. Standalone it renders a row that nothing manages — no keyboard model, no ARIA menu context, no dismissal.

  • The menu closes itself. The item emits mdClick; md-fab-menu listens for it, calls close() and restores focus to the anchor. Your handler runs the action, not the dismissal.
  • mdClick has no detail (it is null). Read the pressed item off e.target, which is the md-fab-menu-item even when the listener sits on the menu — e.currentTarget is whatever you attached to.
  • rovingFocusVisible is set by the parent during arrow-key navigation so the focus ring appears on the roved item even when DOM focus hasn’t moved. Don’t set it yourself.
  • Both disabled and soft-disabled block activation and grey the row. disabled additionally sets pointer-events: none, so it cannot be clicked or hovered. Neither removes the item from the menu’s keyboard model: the menu’s roving tabindex and its arrow / Home / End / typeahead navigation walk every item, so a disabled branch is still reachable and announced (aria-disabled="true"). Prefer omitting an action you never want reached.
  • The label prop and the default slot are alternatives: label wins, and the slot is the fallback when it is empty.

An item takes a slotted glyph in the icon slot in place of the icon prop when you need an SVG or emoji:

Disabled, soft-disabled, and slotted icons
states
slotted glyphs
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="inline-size:100%;display:grid;grid-template-columns:1fr 1fr;gap:24px;">
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">states</div>
    <div style="min-block-size:200px;display:grid;place-items:end center;"><md-fab id="fm-states" icon="add" aria-label="States"></md-fab></div>
    <md-fab-menu anchor="fm-states" menu-label="Create">
      <md-fab-menu-item icon="edit" label="Edit"></md-fab-menu-item>
      <md-fab-menu-item icon="share" label="Share (disabled)" disabled></md-fab-menu-item>
      <md-fab-menu-item icon="delete" label="Delete (soft-disabled)" soft-disabled></md-fab-menu-item>
    </md-fab-menu>
  </div>
  <div>
    <div style="opacity:.65;font-size:.75rem;font-family:ui-monospace,monospace;margin-block-end:8px;">slotted glyphs</div>
    <div style="min-block-size:200px;display:grid;place-items:end center;"><md-fab id="fm-slot" variant="tertiary-container" icon="add" aria-label="Slotted"></md-fab></div>
    <md-fab-menu anchor="fm-slot" variant="tertiary" menu-label="Create">
      <md-fab-menu-item label="Star">
        <svg slot="icon" viewBox="0 0 24 24" width="18" height="18" fill="currentColor"><path d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z"/></svg>
      </md-fab-menu-item>
      <md-fab-menu-item label="Rocket">
        <span slot="icon" aria-hidden="true">🚀</span>
      </md-fab-menu-item>
    </md-fab-menu>
  </div>
</div>

Properties

PropertyAttributeTypeDefaultReflects
iconiconstring''
labellabelstring''
disableddisabledbooleanfalseYes
softDisabledsoft-disabledbooleanfalseYes
rovingFocusVisibleroving-focus-visiblebooleanfalse
densitydensity0 | -1 | -2 | -3 | -40Yes

Slots

SlotDescription
(default)
iconCustom leading icon (replaces icon prop)

CSS Custom Properties

Override on the host element for per-instance theming:

PropertyDescription
--md-fab-menu-item-container-colorContainer background
--md-fab-menu-item-label-colorLabel + icon color
--md-fab-menu-item-icon-colorIcon color override
--md-fab-menu-item-icon-sizeIcon dimensions
--md-fab-menu-item-container-shapeBorder-radius override

CSS Shadow Parts

Style internal elements through shadow DOM with ::part():

PartDescription
state-layerState-layer overlay
iconLeading icon (fallback)
labelLabel text wrapper

The colour properties above are set on the menu and inherited. These three are the item’s own, for when one branch needs to differ from the rest:

Custom propertyPurposeDefault
--md-fab-menu-item-icon-colorIcon colour, independent of the labelInherits the label colour
--md-fab-menu-item-icon-sizeIcon boxmax(16px, 20px + density)
--md-fab-menu-item-container-shapeItem border radius--md-sys-shape-corner-full
Per-item shape, icon size and icon colour
Show code for each technology
<!-- index.html <head> — the icon font the components draw from -->
<link rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=swap">

<!-- index.html — register the AWC UI elements once -->
<script type="module">
  import '@awc-ui/core/define';
</script>

<div style="inline-size:100%;min-block-size:200px;display:grid;place-items:end center;padding-block-end:16px;">
  <md-fab id="fm-item-theme" icon="add" aria-label="Create"></md-fab>
</div>
<md-fab-menu anchor="fm-item-theme" menu-label="Create">
  <md-fab-menu-item icon="description" label="Default"></md-fab-menu-item>
  <md-fab-menu-item icon="warning" label="Squared off" style="--md-fab-menu-item-container-shape: 8px;"></md-fab-menu-item>
  <md-fab-menu-item icon="bolt" label="Bigger, tinted icon" style="--md-fab-menu-item-icon-size: 28px; --md-fab-menu-item-icon-color: var(--md-sys-color-error);"></md-fab-menu-item>
</md-fab-menu>

md-fab · md-menu · md-button · md-icon-button · md-select

For AI Agents — md-fab-menu

Two artefacts to give your AI agent so it generates correct UI with this component. The per-component spec answers "how do I use this exact tag?". The main-llm spec answers "which tag should I pick in the first place?".

Per-component

md-fab-menu spec card

Identity · when to use / when NOT · decision cues · behavioural contract · do/don't · anti-patterns · full API. Paste into your agent when you're implementing with this component.

Main-LLM spec

AWC UI Operator's Manual

System-prompt preamble · decision matrix · token reference · page recipes · anti-patterns. Paste into the system prompt at the start of a piece of work.

Open spec

md-fab-menu readme.md

# md-fab-menu

<!-- llm:meta
tag: md-fab-menu
category: actions
status: md3-mapped
m3-guidelines: https://m3.material.io/components/fab-menu/guidelines
form-associated: false
depends-on: none
used-by: none
accepts-children: md-fab-menu-item
-->

**A FAB that fans out into 2–6 related actions.** Anchors to an existing
`md-fab` by `id`, morphs that FAB's icon to `close` while open, and manages
the popup's ARIA wiring, roving focus, and dismissal.

> Setup, theming, density and i18n are configured once for the whole library —
> see [`main-llm.md`](../../../../../main-llm.md), the library-wide manual that ships
> alongside these files.

---

## When to use

- One prominent creation point that branches into **2–6** related actions
  (new doc / new sheet / new slide; photo / video / file).
- All the branches are **positive, creation-flavored** actions of comparable
  weight.

## When NOT to use

| Situation | Use instead |
|---|---|
| Exactly one primary action | `md-fab` alone |
| More than ~6 actions | `md-menu`, or a dedicated screen |
| Overflow / secondary / destructive actions | `md-menu` from a `md-icon-button` |
| A screen that already has a toolbar or navigation rail | `md-menu` — M3 says don't pair a FAB menu with either |
| Options that select a value rather than trigger an action | `md-select` / `md-segmented-button-set` |
| A menu attached to a normal button | `md-menu` |

## Decision cues

| Need | Setting |
|---|---|
| Items stack above the FAB (bottom-end placement) | `placement="up"` (default) |
| Items stack below (FAB near the top) | `placement="down"` |
| Let the component choose from viewport space | `placement="auto"` |
| Higher-emphasis open state | `variant="primary"` (default) |
| Softer tone | `variant="secondary"` / `"tertiary"` |
| No open/close animation (tests, reduced motion) | `quick` |

## API contract

The FAB itself is **your** element, referenced by `id`. The menu does not render
a trigger.

```html
<md-fab id="create-fab" icon="add" aria-label="Create"></md-fab>

<md-fab-menu anchor="create-fab" placement="up" variant="primary">
  <md-fab-menu-item icon="description" label="Document"></md-fab-menu-item>
  <md-fab-menu-item icon="table_chart" label="Spreadsheet"></md-fab-menu-item>
  <md-fab-menu-item icon="slideshow" label="Presentation"></md-fab-menu-item>
</md-fab-menu>
```

| Prop | Type | Default | Purpose |
|---|---|---|---|
| `open` | `boolean` | `false` | Open state |
| `anchor` | `string` | `''` | **`id` of the trigger element** |
| `variant` | `'primary' \| 'secondary' \| 'tertiary'` | `'primary'` | Open-state FAB color and item container tone |
| `placement` | `'up' \| 'down' \| 'auto'` | `'up'` | Fan-out direction |
| `quick` | `boolean` | `false` | Skip animation |
| `menu-label` | `string` | `'Actions'` | Accessible name of the `role="menu"` popup |
| `density` | `-1…-4` | `0` | Density rung (`0` is the uncompacted default; only the four negative rungs do anything) |

**Slot** — `(default)`: the `md-fab-menu-item` children.

**Events** — `mdOpen` and `mdClose`, both with `void` detail, and both default
Stencil events (they bubble and are composed).

**Methods** — `show(): Promise<void>` opens immediately; `close(): Promise<void>`
returns before the close finishes — unless `quick` is set it flips `open` to
`false` about 180ms later, after the exit animation.

**Parts** — none. The component exposes no `part=` attributes; theme it through
the custom properties below.

### Behavioral contract worth knowing

- **`anchor` is a global DOM `id`**, resolved with `document.getElementById`.
  The anchor must be in the light DOM and the id unique on the page. It is
  looked up when `anchor` changes and when the menu opens.
- While open, the component **writes to your anchor**: `aria-expanded`,
  `aria-haspopup="menu"`, `aria-controls`, and it swaps `anchorEl.icon` to
  `close`, restoring the original on close. Don't fight it by setting those
  yourself.
- The popup is `role="menu"` with `aria-orientation="vertical"`, and is
  `position: fixed` — the component positions itself against the anchor's
  rect every animation frame while open, so it tracks scrolls and reflows.
- Keyboard, while open: `Escape` closes; `Home`/`End` jump to the first/last
  item; typing a character does **typeahead** over item labels (300ms buffer);
  `Tab`/`Shift+Tab` step through the items and close the menu when they run off
  the end. `ArrowUp`/`ArrowDown` are **placement-aware** — with `placement="up"`
  the items sit above the FAB, so `ArrowUp` walks *away* from the anchor and
  `ArrowDown` walks back toward it; `placement="down"` reverses that.
- **Clicking an item closes the menu and returns focus to the anchor.** The
  component listens for `mdClick` from its own subtree. A click outside the
  menu and outside the anchor also closes it.
- **Focus always returns to the anchor on close**, however the menu was
  opened. What *is* activation-aware is whether focus moves **into** the menu on
  open: opening via keyboard, or from an already-focused FAB, focuses the first
  item; a pointer click on an unfocused FAB only primes the roving tabindex and
  leaves focus where it was.
- The popup's accessible name comes from `menu-label` (default `"Actions"`).
  It is the only thing naming the `role="menu"` container, so a translated app
  must set it.
- `open` on first render is supported: the anchor is morphed and wired, but
  `mdOpen` is deliberately **not** emitted and focus is not moved, because that
  state is not an interaction.
- On close the component sets `aria-expanded="false"` on your anchor but leaves
  `aria-haspopup="menu"` and `aria-controls` in place — the anchor keeps
  advertising that it owns a menu.

---

## Do / Don't

Sourced from [M3 · FAB menu · Guidelines](https://m3.material.io/components/fab-menu/guidelines).

| ✅ Do | ❌ Don't |
|---|---|
| Give the menu **2–6** items | Don't use a FAB menu with a single item — use a plain `md-fab` |
| Keep every item's label | Don't remove labels from items |
| Keep icons on items to differentiate them | Only drop an icon if genuinely necessary — it's what separates the rows |
| Keep padding consistent between container, icon, text | Don't expand item container sizes |
| Keep the stock FAB-menu shapes | Don't restyle the shapes |
| Place a FAB next to toolbars and other components | Don't use a **FAB menu** with a toolbar or navigation rail |
| Keep actionable elements and their focus rings visible behind the open menu | Don't fully cover an actionable element and its focus indicator |
| Use it for positive, creation-type actions | Don't fan out destructive or unrelated actions |

---

## Patterns

```html
<!-- Standard bottom-end create menu -->
<md-fab id="fab" icon="add" aria-label="Create"
        style="position:fixed; inset-block-end:24px; inset-inline-end:24px;"></md-fab>

<md-fab-menu anchor="fab" placement="up">
  <md-fab-menu-item icon="edit"  label="New note"></md-fab-menu-item>
  <md-fab-menu-item icon="photo" label="Upload photo"></md-fab-menu-item>
  <md-fab-menu-item icon="mic"   label="Record audio"></md-fab-menu-item>
</md-fab-menu>

<script type="module">
  const menu = document.querySelector('md-fab-menu');
  menu.addEventListener('mdOpen',  () => console.log('opened'));
  menu.addEventListener('mdClose', () => console.log('closed'));

  // The menu closes itself and restores focus after an item click —
  // just run the action.
  document.querySelectorAll('md-fab-menu-item').forEach((item) =>
    item.addEventListener('mdClick', () => console.log('chose', item.label))
  );
</script>
```

```html
<!-- Top-anchored FAB, menu opens downward -->
<md-fab id="top-fab" icon="add" aria-label="Create"></md-fab>
<md-fab-menu anchor="top-fab" placement="down" variant="tertiary">
  <md-fab-menu-item icon="link" label="Add link"></md-fab-menu-item>
  <md-fab-menu-item icon="attach_file" label="Attach file"></md-fab-menu-item>
</md-fab-menu>

<!-- Localized popup name; open programmatically -->
<md-fab id="es-fab" icon="add" aria-label="Crear"></md-fab>
<md-fab-menu id="es-menu" anchor="es-fab" menu-label="Acciones" quick>
  <md-fab-menu-item icon="description" label="Documento"></md-fab-menu-item>
  <md-fab-menu-item icon="photo" label="Foto"></md-fab-menu-item>
</md-fab-menu>
<script type="module">
  await customElements.whenDefined('md-fab-menu');
  await document.getElementById('es-menu').show();
</script>
```

## Anti-patterns

| ❌ Wrong | ✅ Right | Why |
|---|---|---|
| `<md-fab-menu>` with no `anchor` | Always set `anchor` to a real element `id` | Without it there is no trigger and no positioning reference. |
| Putting the `md-fab` **inside** `md-fab-menu` | Keep the FAB outside; reference it by `id` | The menu only accepts `md-fab-menu-item` children. |
| Setting `aria-expanded` / `aria-haspopup` on your FAB | Let the menu manage them | It writes them on open and sets `aria-expanded="false"` on close. |
| Setting `anchorEl.icon` while the menu is open | Leave the icon alone | The menu saves and restores it around the `close` morph. |
| A single-item FAB menu | Plain `md-fab` | M3 names this explicitly. |
| A FAB menu on a screen with a navigation rail | `md-menu` | M3 says don't combine them. |
| Calling `close()` from your `mdClick` handler | Just run the action | The menu already closes itself and restores focus to the anchor. |
| `menu.close(); assert(!menu.open)` | `await` the animation, or set `quick` | `close()` resolves before `open` flips — the exit animation runs ~180ms first. |
| Putting the trigger `md-fab` inside a different shadow root than the menu | Keep both in the same document tree | `anchor` resolves with `document.getElementById`, which does not cross shadow boundaries. |
| An `id` that isn't unique | Unique document-wide id | Lookup is `getElementById` — first match wins. |
| Leaving `menu-label` at its English default in a localized app | Translate it | It is the popup's only accessible name. |

## Accessibility, RTL, density, i18n

**Accessibility**
- The popup is `role="menu"`; items are its rows. `Escape` closes,
  `ArrowUp`/`ArrowDown` rove, and focus returns to the FAB when the interaction
  began from the keyboard.
- The component wires `aria-expanded`/`aria-haspopup`/`aria-controls` onto your
  anchor — so the anchor must be a real, focusable control (`md-fab`).
- M3 requires that an open menu not completely obscure another actionable
  element **or its focus indicator**. Verify at your smallest viewport.
- The closed menu is `aria-hidden`, so its items are not announced.

**RTL** — the stack is vertical, so `placement` is unaffected. Position the
anchor with logical properties so the whole cluster moves to the correct corner.

**Density** — `density="-1…-4"`; only those four rungs exist and omitting the
attribute is the uncompacted default. Because the items are light-DOM children,
the rung's `--md-sys-density-scale` inherits straight down to them. `density="0"`
does **not** opt out of an ancestor's `data-density` rung — reset the scale with
`style="--md-sys-density-scale: 0"` instead.

**i18n** — translate item `label`s and `menu-label`. The latter defaults to the
English `"Actions"` and is the popup's only accessible name.

## Related components

`md-fab` · `md-fab-menu-item` · `md-menu` · `md-button` · `md-icon-button`

## Theming

| Custom property | Purpose | Default |
|---|---|---|
| `--md-fab-menu-item-gap` | Spacing between stacked items | `--md-sys-spacing-gap-xs` (4px) |

`--md-fab-menu-item-gap` is the only property this stylesheet reads. The item
hooks (`--md-fab-menu-item-container-color`, `--md-fab-menu-item-label-color`,
`--md-fab-menu-item-icon-color`, `--md-fab-menu-item-icon-size`,
`--md-fab-menu-item-container-shape`) are read by `md-fab-menu-item`, but since
the items are light-DOM children you can set them once on `md-fab-menu` and
they inherit to every row.

**CSS parts** — none.

```css
md-fab-menu {
  --md-fab-menu-item-gap: 8px;
  --md-fab-menu-item-container-color: var(--md-sys-color-surface-container-high);
}
```

<!-- Auto Generated Below -->


## Properties

| Property    | Attribute    | Description                                                                                                                                                                                                                                                                                                                                    | Type                                     | Default     |
| ----------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ----------- |
| `anchor`    | `anchor`     | ID of the anchor FAB element to position relative to.                                                                                                                                                                                                                                                                                          | `string`                                 | `''`        |
| `density`   | `density`    | Local density rung. Drives the same `--md-sys-density-scale` signal that a global `data-density` ancestor sets, so a local value simply overrides the inherited one. 0 = default, -4 = ultra-compact.                                                                                                                                          | `-1 \| -2 \| -3 \| -4 \| 0`              | `0`         |
| `menuLabel` | `menu-label` | Accessible name for the popup itself (the `role="menu"` container).  A prop rather than a hardcoded string, matching how every other user-facing string in the library is localised: components stay i18n-engine-agnostic and the consumer resolves the text from its own dictionary. The default is English, so a translated app must set it. | `string`                                 | `'Actions'` |
| `open`      | `open`       | Whether the menu is open.                                                                                                                                                                                                                                                                                                                      | `boolean`                                | `false`     |
| `placement` | `placement`  | Direction items fan out from the FAB. - 'up': items stack above the FAB (default, standard bottom-right placement) - 'down': items stack below the FAB - 'auto': detect based on available viewport space                                                                                                                                      | `"auto" \| "down" \| "up"`               | `'up'`      |
| `quick`     | `quick`      | Skip open/close animation.                                                                                                                                                                                                                                                                                                                     | `boolean`                                | `false`     |
| `variant`   | `variant`    | Color set for the menu. Controls the FAB's open-state color (vibrant) and item container color (softer).                                                                                                                                                                                                                                       | `"primary" \| "secondary" \| "tertiary"` | `'primary'` |


## Events

| Event     | Description                 | Type                |
| --------- | --------------------------- | ------------------- |
| `mdClose` | Fires when the menu closes. | `CustomEvent<void>` |
| `mdOpen`  | Fires when the menu opens.  | `CustomEvent<void>` |


## Methods

### `close() => Promise<void>`

Closes the menu programmatically.

#### Returns

Type: `Promise<void>`



### `show() => Promise<void>`

Opens the menu programmatically.

#### Returns

Type: `Promise<void>`




----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*

AWC UI Operator’s Manual

# main-llm.md — AWC UI build director

<!-- llm:meta
role: director
audience: llm
library: "@awc-ui/core"
component-count: 57
sub-component-count: 24
manual-count: 81
per-component-docs: ./packages/core/src/components/<tag>/readme.md
-->

**You are building a web app with AWC UI, a Material Design 3 web-component
library.** This file is the entry point and the only document you need before
writing UI code. Everything here is self-contained: tokens, recipes,
composition rules and the ship checklist. Per-component detail lives in
`./packages/core/src/components/<tag>/readme.md` — e.g.
[`md-button`](./packages/core/src/components/md-button/readme.md).

Your job, in order:

1. **Interview** the user (§1). Do not skip it and do not guess.
2. **Lock the configuration** their answers imply (§2) and bootstrap it (§3–§4).
3. **Route every UI need through the decision matrix** (§5) — never pick a
   component by name-similarity.
4. **Load the component's readme.md before writing a single line of its
   markup** (§6). The file is
   `./packages/core/src/components/<tag>/readme.md` — read it in full, do not
   skim it, and do not write the markup from memory of a similar library. Each
   one has a `When NOT to use`, a `Do / Don't` table sourced from
   [m3.material.io](https://m3.material.io), and an `Anti-patterns` table of
   mistakes models actually make. If you are about to use three components,
   load all three readmes first.
5. **Check what nests inside what** (§7) and start from a recipe (§8) rather
   than from a blank page.
6. **Apply the universal rules** (§9) — the API, content and accessibility
   rules every component is bound by, and the ones §10 checks you against.
7. **Run the ship checklist** (§10) before declaring done.

**Fail closed.** If you cannot satisfy a step — no component fits, a token
doesn't exist, an accessible name has nowhere to come from — say so and ask.
Do not invent an `md-*` tag, a prop, or a token. If it is not in this file or
in the component's manual, it does not exist.

---

## §1 — Interview the user

Ask these **one at a time**, in this order. Each answer closes off decisions
downstream, so don't batch them into a wall of questions. Skip a question only
if the user has already answered it unprompted.

If the user says "just pick sensible defaults", use the **bold** option and tell
them what you chose.

### 1.1 Scope and shape

1. **What is the app?** One or two sentences — domain, primary job, who uses it.
2. **What kind of surface is it?**
   - Internal tool / admin console / dashboard
   - Data-heavy CRUD application
   - Consumer-facing product
   - Marketing or content site
   - Mobile-first / PWA
3. **Which framework?** React · Angular · Vue · Svelte · **plain HTML** ·
   Next · Nuxt · SvelteKit · Astro
4. **Does it server-render?** (SSR/SSG, or **client-only SPA**)
5. **Roughly how many distinct screens**, and what are the top 3?

### 1.2 Look and feel

6. **Density** — how much information per screen?
   - `0` — **default**, comfortable, touch-friendly
   - `-1` / `-2` — compact; typical for admin consoles
   - `-3` / `-4` — ultra-compact; dense data tables, trading/ops screens
7. **Theme** — light only, dark only, or **both with a user toggle**?
   Does it follow the OS preference?
8. **Brand color** — a seed/primary color, or **stock MD3 palette**?
9. **Expressive motion** — keep **ripple and shape-morph on** (default), or turn
   them off for a flatter, more utilitarian feel?
10. **Shape language** — **rounded** (MD3 default) or squared?

### 1.3 Internationalization

11. **How many locales**, and which?
12. **Any RTL locales** (Arabic, Hebrew, Farsi, Urdu)? — this changes layout
    verification and directional-icon handling.
13. **Which i18n engine?** (i18next, vue-i18n, ngx-translate, Paraglide, custom)
    Components are engine-agnostic — you localize in the consumer layer.
14. **Locale-formatted values** — dates, numbers, currency? Which locale drives
    `Intl`?

### 1.4 Data and forms

15. **Is there significant tabular data?** How many rows, and is it
    server-paged? (Drives how you page `md-table` — it holds the state, you
    supply each page of rows.)
16. **Are there charts?** Which questions should they answer?
17. **How heavy are the forms?** Validation rules, async validation, multi-step?
18. **Rich text editing anywhere?** — ⚠️ **AWC UI has no RTE component.** If yes,
    you must integrate a third-party editor (TipTap, Lexical, Quill) and style
    it to the MD3 tokens yourself. Confirm this with the user explicitly.

### 1.5 Constraints

19. **Accessibility target** — **WCAG 2.1 AA** (what the library is tested to),
    or stricter?
20. **Browser/device support floor?**
21. **Anything already decided** you must not change — existing design system,
    router, state library, CSS approach?

---

## §2 — Map answers to configuration

| Answer | What you set |
|---|---|
| Admin console / data-heavy | `data-density="-1"` or `-2` on `<html>`; prefer `size="xs"`/`"sm"` on actions |
| Consumer / marketing | leave density alone (`0` is the default); larger button sizes (`md`/`lg`) for CTAs |
| Mobile-first | `md-navigation-bar` + `md-fab`; avoid `md-navigation-rail`, `md-transfer-list`, wide tables |
| Desktop-first | `md-navigation-rail` or `md-app-bar`; rail over bottom bar |
| Dark mode | `data-theme="dark"` on `<html>`; wire a toggle, and mirror OS via `prefers-color-scheme` |
| Both themes with toggle | persist the choice; set the attribute before first paint to avoid a flash |
| Brand color | override the `--md-sys-color-*` roles in your own stylesheet, loaded after the tokens (§4.2) |
| Flat / utilitarian | `data-ripple="off"` and `data-shape-morph="off"` on `<html>` |
| Any RTL locale | `dir="rtl"` on `<html>`; add `mirror-icon` to `md-button`s with directional glyphs; swap the glyph name yourself everywhere else (§4.5) |
| Multiple locales | build a dictionary in the consumer layer and feed component text props from it; never hardcode strings in markup |
| `Intl`-formatted values | pass a `locale` prop where a component exposes one; format everything else before it reaches the component |
| SSR | import from `@awc-ui/core/hydrate` on the server; use the client/server wrappers in `@awc-ui/react` |
| Heavy forms | components are form-associated via `ElementInternals` — use a real `<form>`, `md-button type="submit"`, and native `required` (§4.7) |
| Rich text | integrate a third-party editor; there is no `md-rich-text` |

### 2.1 Global switches — the complete set

All are attributes on `<html>` (or any ancestor; the nearest one wins).

```html
<html
  lang="en"
  dir="ltr"                  <!-- or rtl -->
  data-theme="dark"          <!-- omit for light -->
  data-density="-1"          <!-- -1 … -4; see below -->
  data-ripple="off"          <!-- default on -->
  data-shape-morph="off"     <!-- default on -->
>
```

**`data-density="0"` is inert.** No `[density="0"]` rule exists — density `0` is
simply the base values on `:root`, and a `0` rule would pin them onto every
element (reflected props write `density="0"` almost everywhere) and break global
inheritance. So the *overriding* range is `-1 … -4`. To escape an inherited rung
for one subtree, reset the scale directly:

```css
.opt-out-of-density { --md-sys-density-scale: 0; }
```

Per-component overrides beat the global one: a `density` prop, or
`ripple="off"` / `shape-morph="off"` on the element. **53 of the 57 top-level
components expose a `density` prop.** The four that don't: `md-divider`,
`md-ripple`, `md-sparkline`, `md-tabs`. (Nine sub-components also lack one —
they inherit density from the parent that owns their layout.)

---

## §3 — Install and bootstrap

```bash
npm install @awc-ui/core
```

**Register everything (recommended).** Two imports, once per app entry — one
defines every component, one loads the tokens. Both come from `@awc-ui/core`
itself, so this path needs no second package:

```ts
import { defineCustomElements } from '@awc-ui/core/loader';
import '@awc-ui/core/css/tokens.css';

defineCustomElements(window);
```

`@awc-ui/core/css/tokens.css` is the complete, self-contained token sheet —
light and dark colour roles, shape, elevation, motion, typescale, spacing and
z-index. It is the same set documented in §4.1.

**One-line alternative.** `@awc-ui/core/define` does both steps in a single
import. It loads the package's own token sheet, so it needs nothing else
installed:

```ts
import '@awc-ui/core/define'; // defines every component + loads the token sheet
```

`define` is client-only (it eval-guards `window`) and, because it imports CSS,
it needs a bundler. Never import it into a server graph.

**Per-component registration**, for size-sensitive bundles — load the token
sheet once yourself:

```ts
import '@awc-ui/core/css/tokens.css';
import '@awc-ui/core/components/md-button';
import '@awc-ui/core/components/md-text-field';
```

**Framework wrappers** — use these instead of raw elements; they handle
registration, typed props, and event binding. Below the version floor, drop to
the raw custom elements and the `loader` import above.

| Framework | Package | Requires |
|---|---|---|
| React / Next | `@awc-ui/react` | React 18+ |
| Angular | `@awc-ui/angular` (`AwcUiModule`) | Angular 17+ |
| Vue / Nuxt | `@awc-ui/vue` | Vue 3 |
| Svelte / SvelteKit | `@awc-ui/svelte` | Svelte 4+ |
| Plain HTML / Astro | `@awc-ui/core/loader` | — |

**SSR** — `@awc-ui/core/hydrate` renders Declarative Shadow DOM on the server.
`@awc-ui/react` ships matching client/server wrappers. Keep `define` and
`loader` out of the server graph; both are browser entries.

**Fonts** — components expect Roboto and Material Symbols Outlined to be
available. The library does **not** inject them. Every `icon="…"` prop renders a
Material Symbols glyph inside shadow DOM, so the font must be registered at the
**document** level (font registration crosses shadow boundaries; class rules do
not — the components declare the class rule inside their own roots):

```html
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined">
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;500&display=swap">
```

To swap the whole library to a different Material Symbols cut, set
`--md-sys-icon-font-family` on `:root` and load the matching `@font-face`.

---

## §4 — Global configuration reference

### 4.1 The token system

All AWC UI styling resolves to design tokens. **Never hardcode hex colours,
pixel radii, shadows, or font stacks** — they break theming, dark mode, density
and RTL in one stroke. Every value below is a real custom property defined by
`@awc-ui/tokens`; you may read them, and you may override them.

#### Color roles

Light is the default; `[data-theme="dark"]` swaps the palette. Every role has a
matching `on-` role for content drawn on top of it.

| Token | Light | Dark | Typical usage |
|---|---|---|---|
| `--md-sys-color-primary` | `#6750A4` | `#D0BCFF` | Filled buttons, active states |
| `--md-sys-color-on-primary` | `#FFFFFF` | `#381E72` | Text/icons on primary |
| `--md-sys-color-primary-container` | `#EADDFF` | `#4F378B` | FAB, selected segments |
| `--md-sys-color-on-primary-container` | `#21005D` | `#EADDFF` | Text on primary-container |
| `--md-sys-color-secondary` | `#625B71` | `#CCC2DC` | Secondary accents |
| `--md-sys-color-secondary-container` | `#E8DEF8` | `#4A4458` | Tonal buttons, chips |
| `--md-sys-color-tertiary` | `#7D5260` | `#EFB8C8` | Tertiary accents |
| `--md-sys-color-tertiary-container` | `#FFD8E4` | `#633B48` | Tertiary surfaces |
| `--md-sys-color-error` | `#B3261E` | `#F2B8B5` | Error / destructive |
| `--md-sys-color-on-error` | `#FFFFFF` | `#601410` | Content on error |
| `--md-sys-color-error-container` | `#F9DEDC` | `#8C1D18` | Error surfaces |
| `--md-sys-color-surface` | `#FFFBFE` | `#1C1B1F` | Page / card background |
| `--md-sys-color-on-surface` | `#1C1B1F` | `#E6E1E5` | Body text |
| `--md-sys-color-surface-variant` | `#E7E0EC` | `#49454F` | Muted fills |
| `--md-sys-color-on-surface-variant` | `#49454F` | `#CAC4D0` | Secondary text, icons |
| `--md-sys-color-surface-container-lowest` | `#FFFFFF` | `#0F0D13` | Lowest surface tier |
| `--md-sys-color-surface-container-low` | `#F7F2FA` | `#1D1B20` | Card / elevated button bg |
| `--md-sys-color-surface-container` | `#F3EDF7` | `#211F26` | Default container tier |
| `--md-sys-color-surface-container-high` | `#ECE6F0` | `#2B2930` | Dialog / menu surfaces |
| `--md-sys-color-surface-container-highest` | `#E6E0E9` | `#36343B` | Highest surface tier |
| `--md-sys-color-outline` | `#79747E` | `#938F99` | Borders (3:1 contrast) |
| `--md-sys-color-outline-variant` | `#CAC4D0` | `#49454F` | Dividers (low contrast) |
| `--md-sys-color-inverse-surface` | `#313033` | `#E6E1E5` | Snackbar, inverse chips |
| `--md-sys-color-inverse-on-surface` | `#F4EFF4` | `#313033` | Content on inverse-surface |
| `--md-sys-color-scrim` | `#000000` | `#000000` | Modal scrims |

**Semantic status roles** — beyond the baseline M3 palette, the library adds
`success`, `warning` and `info`, each with `on-`, `-container` and
`on-…-container` companions, in both themes, AA-verified. Used by `md-chip`,
`md-badge`, `md-meter`, `md-status-dot`.

| Token | Light | Dark |
|---|---|---|
| `--md-sys-color-success` | `#2E6B4F` | `#9DD5B0` |
| `--md-sys-color-success-container` | `#B8F0CE` | `#14512F` |
| `--md-sys-color-warning` | `#7A5900` | `#EFC148` |
| `--md-sys-color-warning-container` | `#FFDF9B` | `#5C4200` |
| `--md-sys-color-info` | `#38608F` | `#A2C9FE` |
| `--md-sys-color-info-container` | `#D3E4FF` | `#1E4975` |

#### Shape tokens

| Token | Value | Typical usage |
|---|---|---|
| `--md-sys-shape-corner-none` | `0px` | Square edges |
| `--md-sys-shape-corner-extra-small` | `4px` | Snackbar, small chips |
| `--md-sys-shape-corner-small` | `8px` | Cards (outlined), small surfaces |
| `--md-sys-shape-corner-medium` | `12px` | Cards (default), inputs |
| `--md-sys-shape-corner-large` | `16px` | Dialogs, large cards |
| `--md-sys-shape-corner-extra-large` | `28px` | Bottom sheets |
| `--md-sys-shape-corner-full` | `9999px` | Buttons, chips, FAB |

Partial-corner variants also exist for surfaces that meet an edge:
`--md-sys-shape-corner-extra-small-top`, `-large-top`, `-large-end`,
`-extra-large-top`. Their values are four-value `border-radius` shorthands
(e.g. `16px 16px 0px 0px`), so assign them to `border-radius`, not to a single
corner.

#### Elevation tokens

`-0` is the keyword `none`; `-1` through `-5` are complete `box-shadow` values,
and those five are **re-declared with deeper shadows under `[data-theme="dark"]`**
— so always use the token rather than copying its value.

| Token | When |
|---|---|
| `--md-sys-elevation-0` | `none` — resting cards, flat surfaces |
| `--md-sys-elevation-1` | Elevated buttons and cards at rest |
| `--md-sys-elevation-2` | Hover bump |
| `--md-sys-elevation-3` | FAB, menus, dialogs at rest |
| `--md-sys-elevation-4` – `-5` | Reserved for the most prominent surfaces |

#### Motion tokens

Durations come in four families of four: `short1…4` (50/100/150/200ms),
`medium1…4` (250/300/350/400ms), `long1…4` (450/500/550/600ms), and
`extra-long1…4` (700/800/900/1000ms).

| Token | Value | When |
|---|---|---|
| `--md-sys-motion-duration-short2` | `100ms` | Buttons, ripples, state layers |
| `--md-sys-motion-duration-medium2` | `300ms` | Dialogs, sheets, menus |
| `--md-sys-motion-duration-long2` | `500ms` | Large surface transitions |
| `--md-sys-motion-duration-extra-long1` | `700ms` | Ambient / chart entrances |
| `--md-sys-motion-easing-standard` | `cubic-bezier(0.2, 0, 0, 1)` | Small utility transitions |
| `--md-sys-motion-easing-standard-accelerate` | `cubic-bezier(0.3, 0, 1, 1)` | Exits |
| `--md-sys-motion-easing-standard-decelerate` | `cubic-bezier(0, 0, 0, 1)` | Entrances |
| `--md-sys-motion-easing-emphasized` | `cubic-bezier(0.2, 0, 0, 1)` | Expressive transitions |
| `--md-sys-motion-easing-emphasized-accelerate` | `cubic-bezier(0.3, 0, 0.8, 0.15)` | Expressive exits |
| `--md-sys-motion-easing-emphasized-decelerate` | `cubic-bezier(0.05, 0.7, 0.1, 1)` | Expressive entrances |
| `--md-sys-motion-easing-linear` | `linear` | Progress, indeterminate loops |

> `--md-sys-motion-easing-emphasized` deliberately equals the standard curve:
> the full M3 emphasized curve is a two-phase path interpolator that CSS cannot
> express. The accelerate and decelerate halves *are* expressible, and are the
> ones to reach for.

MD3 Expressive also ships spring pairs, each an easing plus its natural
duration: `--md-sys-motion-spring-{spatial,effects}-{fast,default,slow}-easing`
and `…-duration`. Spatial = position/size/shape; effects = colour/opacity.

#### State-layer opacities

| Token | Value |
|---|---|
| `--md-sys-state-hover-state-layer-opacity` | `0.08` |
| `--md-sys-state-focus-state-layer-opacity` | `0.12` |
| `--md-sys-state-pressed-state-layer-opacity` | `0.12` |
| `--md-sys-state-dragged-state-layer-opacity` | `0.16` |
| `--md-sys-state-disabled-container-opacity` | `0.12` |
| `--md-sys-state-disabled-content-opacity` | `0.38` |

#### Typography, spacing and layering

- **Typescale** — `--md-sys-typescale-<role>-<size>-*` for
  `display`/`headline`/`title`/`label`/`body` × `large`/`medium`/`small`. Each
  role exposes `-font-family`, `-font-size`, `-line-height`, `-font-weight`,
  `-letter-spacing`, plus a `-font` shorthand
  (e.g. `--md-sys-typescale-headline-medium-font: 400 28px/36px Roboto, sans-serif`).
  Use the shorthand on the `font` property for headings you write yourself.
- **Spacing** — a 4px scale that tightens with density:
  `--md-sys-spacing-inset-{xs,sm,md,lg,xl}` (internal padding, 4/8/12/16/24px)
  and `--md-sys-spacing-gap-{xs,sm,md,lg}` (between siblings, 4/8/12/16px), plus
  `--md-sys-spacing-row-height` (`56px` at density 0).
- **Layering** — `--md-sys-z-index-app-bar` (100), `-navigation` (200),
  `-bottom-sheet` (300), `-popup` (1000), `-dialog-scrim` (1001), `-tooltip`
  (1500), `-snackbar` (2000). Use these instead of inventing z-indexes, or your
  overlay will land under a menu.

### 4.2 Theming and rebranding

To rebrand, redefine the role variables **after** the tokens stylesheet — both
themes, or dark mode inherits your light brand colour:

```css
:root {
  --md-sys-color-primary: #00629E;
  --md-sys-color-on-primary: #FFFFFF;
  --md-sys-color-primary-container: #CFE5FF;
  --md-sys-color-on-primary-container: #001D33;
}
[data-theme="dark"] {
  --md-sys-color-primary: #9BCBFF;
  --md-sys-color-on-primary: #003354;
  --md-sys-color-primary-container: #004A78;
  --md-sys-color-on-primary-container: #CFE5FF;
}
```

Per-component knobs are `--md-<component>-*` custom properties, listed in each
manual's Theming section (`--md-button-container-color`,
`--md-card-container-shape`, …). Prefer those over `::part()`, and prefer
`::part()` over reaching into shadow internals, which are unstable and will
break on any release.

**Overriding a colour role forfeits the library's contrast testing.** Re-verify
AA (4.5:1 text, 3:1 borders and dividers) after any palette change. The Theme
Generator at <https://awc-ui.dev/theme-generator> takes a seed colour, emits both
palettes as `--md-sys-color-*` overrides, and runs the WCAG checks live — use it
rather than hand-picking container and `on-` pairs.

### 4.3 Density

`data-density` steps `-1 → -4`; each rung trims ~4px of padding and touch
target, driving `--md-sys-density-scale` and the spacing tokens. `-4` is the
floor. Set it globally, override locally with the `density` prop. Do not go
below `-2` on touch-primary surfaces — you will break the 48px target.

Two details that bite:

- **`density="0"` does nothing** — see §2 for why, and for the
  `--md-sys-density-scale: 0` escape hatch.
- **`md-table` accepts two vocabularies**: the semantic `compact` / `standard` /
  `comfortable` (row heights 36 / 52 / 60px) *and* the numeric rungs. They
  compose — `density="compact"` inside a `data-density="-2"` region condenses
  further.

### 4.4 Dark mode

Set `data-theme="dark"` on `<html>` (or any ancestor — the nearest wins). The
tokens swap automatically and inherit across every shadow boundary; no
per-component code. To mirror the OS, read `prefers-color-scheme` and write the
attribute **before first paint**, or the page flashes light.

### 4.5 RTL

Layout is written with CSS logical properties, so it flips with `dir="rtl"`
without extra work. Two things still need you:

- **Directional glyphs do not flip.** Material Symbols are not auto-mirrored.
  `md-button` has a `mirror-icon` prop that mirrors its own leading/trailing
  glyph — set it on buttons using arrows, chevrons, `send`, `reply`, and leave
  it off for `add`, `search`, `favorite`. **`mirror-icon` exists only on
  `md-button`.** Everywhere else — `md-icon-button icon="…"`, `md-list-item`
  leading/trailing icons, `md-app-bar leading-icon` — swap the glyph name
  yourself (`arrow_back` ↔ `arrow_forward`).
- **Icon props you supply yourself** — e.g. `md-transfer-list`'s
  `move-right-icon` / `move-left-icon` / `move-all-*-icon` — must be swapped by
  you when the direction flips.

Never write physical CSS (`margin-left`, `padding-right`, `left`) around these
components. Use `margin-inline-start`, `padding-inline-end`, `inset-inline-end`.

### 4.6 Internationalization

Components are **i18n-engine-agnostic by design**. Every user-visible string is
either slotted content or a prop. Localize in the consumer layer: resolve your
dictionary to plain strings, then pass them in. Do not add a translation engine
inside a component. `locale` props exist only where a component computes an
`Intl`-formatted value itself: `md-date-picker`, `md-number-field`,
`md-meter`, `md-dialog`, and the charts (`md-bar-chart`, `md-line-chart`,
`md-area-chart`, `md-pie-chart`). `md-time-picker` has no
`locale` prop — it takes `format="12h" | "24h"` instead.

Templated strings keep their placeholder tokens when translated — translate
around the braces, don't remove them:

```html
<md-transfer-list count-template="{checked} / {total} ausgewählt"></md-transfer-list>
```

Other templated props: `md-autocomplete status-template`, `md-otp-field
cell-label-template`. Default prop values are English (`Search`, `Dismiss`,
`No results`, `Move selected to target`, …) — every one of them needs
translating in a localized app.

### 4.7 Forms and validation

Fourteen components are form-associated via `ElementInternals`, so they
participate in `FormData` and constraint validation like native controls:

`md-text-field` · `md-number-field` · `md-otp-field` · `md-select` ·
`md-multi-select` · `md-autocomplete` · `md-checkbox` · `md-radio` ·
`md-switch` · `md-slider` · `md-rating` · `md-date-picker` · `md-time-picker` ·
`md-button`

Rules:

- Use a real `<form>`. `md-button type="submit"` calls `form.requestSubmit()`
  (not `submit()`), so the `submit` event fires **and** built-in constraint
  validation runs. `required` genuinely blocks submit.
  `md-button type="reset"` calls `form.reset()`.
- Give every control a `name`, or it will not appear in `FormData`.
- Do **not** add hidden `<input>`s to mirror values — that's the old pattern and
  it double-submits.
- Validity changes are announced on a `mdValidityChange` event on the control.
  Error presentation is `error` + `error-text` on the field.
- Boolean state props differ by control — `md-checkbox` uses `checked`,
  `md-switch` uses **`selected`**, `md-select-option` uses `selected`. Check the
  manual; guessing `checked` on a switch silently does nothing.

---

## §5 — Component decision matrix

Route by **need**, not by name. If the need isn't listed, find the closest row
and read that component's `When NOT to use`.

### 5.1 Actions

| Need | Use | Don't use |
|---|---|---|
| Discrete labelled action | `md-button` | `md-chip`, raw `<button>` |
| Icon-only action | `md-icon-button` | `md-button` with no label |
| A destructive action | `md-button` + `md-dialog` to confirm | an unconfirmed `filled` button |
| The single most prominent screen action (mobile) | `md-fab` | a second `filled` `md-button` |
| One prominent action that expands to several | `md-fab-menu` + `md-fab-menu-item` | a stack of FABs |
| Primary action + variants of it | `md-split-button` | button + separate menu |
| 2–5 related actions as one unit | `md-button-group` | loose adjacent buttons |
| Mutually exclusive view/mode switch | `md-segmented-button-set` + `md-segmented-button` | radio buttons, tabs |
| Overflow / contextual actions | `md-menu` + `md-menu-item` | a row of text buttons |

### 5.2 Text input

| Need | Use | Don't use |
|---|---|---|
| Any single-line or multi-line text entry | `md-text-field` | raw `<input>` |
| A number with steppers and locale formatting | `md-number-field` | `md-text-field type="number"` |
| A one-time code / PIN | `md-otp-field` | a row of text fields |
| Text entry with suggestions | `md-autocomplete` | `md-select` |
| Site/app-wide search with a results surface | `md-search` | `md-text-field` with an icon |

### 5.3 Selection

| Need | Use | Don't use |
|---|---|---|
| One of many, from a list | `md-select` + `md-select-option` | radio group over ~7 options |
| One of few (2–5), all visible | `md-radio` | `md-select` |
| Several of many | `md-multi-select` | many `md-checkbox`es |
| Several of few, all visible | `md-checkbox` | `md-multi-select` |
| Instant on/off setting | `md-switch` | `md-checkbox` |
| A value in a numeric range | `md-slider` | `md-text-field type=number` |
| Subjective score | `md-rating` | slider |
| A color | `md-color-picker` | `<input type=color>` |
| Assign a subset from a bounded pool, side by side | `md-transfer-list` | two lists + buttons |
| Filter / attribute / removable entry | `md-chip` | small buttons |
| A date | `md-date-picker` | three selects |
| A time | `md-time-picker` | text field |

### 5.4 Navigation

| Need | Use | Don't use |
|---|---|---|
| Top-level destinations, mobile | `md-navigation-bar` + `md-navigation-tab` | tabs |
| Top-level destinations, desktop | `md-navigation-rail` + `md-navigation-rail-tab` | bottom bar |
| App header: title, actions, search | `md-app-bar` | a custom `<header>` |
| A dense action strip | `md-toolbar` | app bar |
| Sibling views **within** one screen | `md-tabs` + `md-tab` + `md-tab-panels` + `md-tab-panel` | navigation bar |
| Hierarchy / where-am-I | `md-breadcrumbs` + `md-breadcrumb-item` | text links |
| A linear multi-step flow | `md-stepper` + `md-step` | tabs |
| Contextual popup actions | `md-menu` + `md-menu-item`, `md-menu-item-group`, `md-sub-menu-item` | dialog |
| Hierarchical command menu (File → Export → PDF) | `md-menu` + `md-sub-menu-item` | nested dialogs |

### 5.5 Containment and feedback

| Need | Use | Don't use |
|---|---|---|
| Group related content | `md-card` | a bare `<div>` with a border |
| Blocking decision or focused task | `md-dialog` | a new page |
| Critical error the user must acknowledge | `md-dialog` | `md-snackbar` |
| Supplementary content from the bottom (mobile) | `md-bottom-sheet` | dialog |
| Supplementary content from the side (desktop) | `md-side-sheet` | dialog |
| Brief confirmation of an action, optionally undoable | `md-snackbar` | dialog, alert |
| Explain a control on hover/focus | `md-tooltip` | a dialog or inline hint |
| Progressive disclosure of sections | `md-accordion` + `md-accordion-item` | tabs |
| Visual separation | `md-divider` | a styled `<hr>` |
| A vertical set of records | `md-list` + `md-list-item` | a table |
| Determinate/indeterminate progress | `md-progress-indicator` | spinner GIF |
| Brand-consistent page/content loading | `md-loading-indicator` | custom spinner |
| Content-shaped loading placeholder | `md-skeleton` | a spinner over the whole page |
| Count or status on an element | `md-badge` | superscript text |
| Compact status dot | `md-status-dot` | a colored emoji |
| Read-only value within a known range (quota, battery) | `md-meter` | `md-progress-indicator` |
| A person or entity image/initials | `md-avatar` | a raw `<img>` |
| Touch feedback inside a custom control | `md-ripple` | custom CSS animation |

### 5.6 Data

| Need | Use | Don't use |
|---|---|---|
| Any table | `md-table-container` wrapping `md-table`, with `-head`/`-body`/`-row`/`-cell`/`-foot` inside the table and `-toolbar`/`-pagination` beside it in the container (§7.1) | a native `<table>` |
| Sorting, selection, paging on that table | the same parts — `md-table` carries the STATE (`sort-by`, `sort-order`, `selection`, `row-offset`, `row-count`, `loading`) and emits events; you own the data and do the actual sorting/paging | expecting it to sort an array for you |
| Hierarchy / reporting lines | `md-organization-chart` | nested lists |
| Compare categories | `md-bar-chart` | pie chart |
| Trend over time | `md-line-chart` | bar chart |
| Trend with cumulative volume | `md-area-chart` | line chart |
| Parts of a whole (≤ ~6 slices) | `md-pie-chart` | bar chart |
| Inline micro-trend in a cell or card | `md-sparkline` | a full chart |

> **There is no data-driven table component.** `md-table` is composable: you
> render the rows. It tracks and announces sort, selection and pagination state
> and emits events when the user changes them, but the sorting, filtering and
> slicing of your data is yours to perform. Render rows from your own array in
> response to those events.

### 5.7 Choosing the variant

The matrix picks the component; this picks its shape. Every value below is a
real enum member — anything not listed here is not a valid value.

| Component | Prop | Values, and when |
|---|---|---|
| `md-button` | `variant` | `filled` the one primary action · `tonal` a strong secondary · `outlined` secondary, and the safe choice for a destructive action behind a confirm · `text` low emphasis, dialog Cancel · `elevated` when it sits on a busy or coloured background (default `filled`) |
| `md-button` / `md-icon-button` / `md-button-group` | `size` | `xs` `sm` `md` `lg` `xl` — default `sm`; go `md`/`lg` for consumer CTAs, `xs`/`sm` for dense admin UI |
| `md-icon-button` | `variant` | `standard` (default) · `filled` · `tonal` · `outlined` |
| `md-button-group` | `variant` | `standard` spaced · `connected` fused into one bar |
| `md-fab` | `size` | `standard` (default) · `medium` · `large` |
| `md-fab` | `variant` | `primary-container` (default) · `secondary-container` · `tertiary-container` · `surface` · `primary` · `secondary` · `tertiary` |
| `md-card` | `variant` | `filled` for a group of comparable items · `elevated` (default) for a hero or featured item · `outlined` for a settings or form section |
| `md-text-field` / `md-select` | `variant` | `outlined` for forms on a surface · `filled` for dense or tinted layouts (`md-text-field` defaults to `filled`, `md-select` to `outlined`) — pick one and use it for every field on the screen |
| `md-text-field` | `type` | any native input type: `password`, `email`, `tel`, `url`, `search`, … (default `text`) |
| `md-text-field` | `multiline` | `"auto-grow"` grows with content · `"fixed"` with `rows` for a fixed comment box · `false` (default) single line |
| `md-search` | `variant` | `contained` (default) · `divided` |
| `md-app-bar` | `variant` | `small` (default) · `medium` · `large` for a prominent headline · `search` for a bar that hosts a field |
| `md-chip` | `variant` | `assist` (default) · `filter` for toggleable facets · `input` for user-entered removable values · `suggestion` |
| `md-chip` | `appearance` | `outlined` (default) · `filled` · `elevated` |
| `md-badge` | `variant` | `small` a bare dot · `large` (default) a count |
| `md-tooltip` | `variant` | `plain` (default) a short label on an icon control · `rich` an explanatory popover that may hold a link or action |
| `md-divider` | — | **no `variant`** — use the booleans `inset`, `inset-start`, `inset-end` |
| `md-side-sheet` | `variant` | `standard` coexists with page content · `modal` overlays with a scrim |
| `md-bottom-sheet` | `variant` | `standard` (default) · `detached` floating above the edge |
| `md-dialog` | `fullscreen` | boolean — a full-screen dialog for a long mobile task |
| `md-date-picker` | `variant` | `modal-input` (default) calendar plus a typed field · `modal` calendar only · `docked` inline, anchored to the field |
| `md-time-picker` | `variant` | `dial` · `input` (default) |
| `md-progress-indicator` | `variant` | `linear` (default) · `circular`; add `indeterminate` when the total is unknown |
| `md-list-item` | `lines` | `1` · `2` · `3` — must match how much supporting text you pass |
| `md-navigation-bar` | — | 3–5 destinations. Fewer than three: use `md-tabs`. More than five: a rail or a menu |
| `md-navigation-rail` | — | 3–7 destinations; cap the overflow with `max-visible` |

### 5.8 Not in the library

Rich text editor · file upload/dropzone · calendar/scheduler view · map ·
toast stack manager (use `md-snackbar` and manage the queue yourself) ·
data grid with virtualized columns. If the user needs one, say so plainly and
integrate a third-party component styled with the MD3 tokens.

**There is no `md-grid`, no `md-data-table`, no `md-layout`, no `md-icon`.**
If a tag is not listed in §6, it does not exist — do not emit it.

---

## §6 — Component inventory

**Every component has exactly one manual, and it is the readme.md in its own
source folder:**

```
./packages/core/src/components/<tag>/readme.md
```

e.g. [`md-select`](./packages/core/src/components/md-select/readme.md),
[`md-button`](./packages/core/src/components/md-button/readme.md).

**Load that file before you use the component.** There is no second, shorter
summary to rely on — this readme is the single source, so anything you do not
read there, you do not know. Each one carries When-to-use, a Do/Don't table
from M3, copy-paste patterns, an anti-patterns table, and the theming surface.

Work through them one at a time: pick the component from the decision matrix
(§5), load its readme, write that component's markup, then move to the next.

There are 81 manuals for 57 components: 24 of them document sub-components that
are only valid inside a parent (a table cell, a tab panel, a select option).
Every sub-component manual names its parent in the first line, and §7 below
summarises the nesting.

`status` in each manual's `llm:meta` block is one of:

- **`md3-mapped`** — has a Material Design 3 guidelines page; the Do/Don't is
  sourced from it.
- **`custom`** — an addition to MD3; guidance is derived house rules.
- **`sub-component`** — only valid inside a specific parent.

| Category | Components |
|---|---|
| Actions | `md-button` `md-icon-button` `md-fab` `md-fab-menu` `md-fab-menu-item` `md-split-button` `md-button-group` `md-segmented-button` `md-segmented-button-set` |
| Text input | `md-text-field` `md-number-field` `md-otp-field` `md-autocomplete` `md-search` |
| Selection | `md-select` `md-select-option` `md-multi-select` `md-checkbox` `md-radio` `md-switch` `md-slider` `md-rating` `md-color-picker` `md-transfer-list` `md-chip` |
| Pickers | `md-date-picker` `md-time-picker` |
| Navigation | `md-app-bar` `md-toolbar` `md-navigation-bar` `md-navigation-tab` `md-navigation-rail` `md-navigation-rail-tab` `md-tabs` `md-tab` `md-tab-panels` `md-tab-panel` `md-breadcrumbs` `md-breadcrumb-item` `md-menu` `md-menu-item` `md-menu-item-group` `md-sub-menu-item` `md-stepper` `md-step` |
| Containment | `md-card` `md-dialog` `md-bottom-sheet` `md-side-sheet` `md-snackbar` `md-tooltip` `md-accordion` `md-accordion-item` `md-divider` `md-list` `md-list-item` |
| Data | `md-table` `md-table-container` `md-table-head` `md-table-body` `md-table-row` `md-table-cell` `md-table-foot` `md-table-toolbar` `md-table-pagination` `md-table-sort-label` `md-table-expand-toggle` `md-organization-chart` |
| Charts | `md-bar-chart` `md-line-chart` `md-area-chart` `md-pie-chart` `md-sparkline` |
| Status & feedback | `md-progress-indicator` `md-loading-indicator` `md-skeleton` `md-badge` `md-status-dot` `md-meter` `md-avatar` `md-ripple` |

---

## §7 — Composition rules

### 7.1 What nests inside what

A sub-component is only valid inside its parent. Putting one anywhere else
produces an unstyled, unregistered-looking element with no keyboard behaviour,
because the parent is what wires roving tabindex, ARIA ids and selection.

| Parent | Children it manages |
|---|---|
| `md-button-group` | `md-button`, `md-icon-button` |
| `md-segmented-button-set` | `md-segmented-button` |
| `md-fab-menu` | `md-fab-menu-item` (anchored to an `md-fab` via `anchor="<id>"`) |
| `md-menu` | `md-menu-item`, `md-sub-menu-item`, `md-menu-item-group` — **not** `md-divider`; separate rows with `md-menu-item`'s own `divider` (or `gap`) prop |
| `md-menu-item-group` | `md-menu-item` |
| `md-sub-menu-item` | a nested `md-menu` in `slot="submenu"` — the items go in *that* menu. There is no default slot, so anything else you nest renders nothing |
| `md-select`, `md-multi-select`, `md-autocomplete` | `md-select-option` |
| `md-list` | `md-list-item`, `md-divider` |
| `md-tabs` | `md-tab` |
| `md-tab-panels` | `md-tab-panel` (one per tab, in tab order) |
| `md-navigation-bar` | `md-navigation-tab` |
| `md-navigation-rail` | `md-navigation-rail-tab`, plus an `md-fab` in `slot="fab"` |
| `md-accordion` | `md-accordion-item` |
| `md-stepper` | `md-step` (horizontal steppers also take `slot="content"`) |
| `md-breadcrumbs` | `md-breadcrumb-item` |
| `md-table-container` | `md-table` — **it wraps the table, not the other way round** — plus `md-table-toolbar` in `slot="top"` and `md-table-pagination` in `slot="bottom"`, which sit outside the scroll region |
| `md-table` | `md-table-head`, `md-table-body`, `md-table-foot` (and bare `md-table-row`). It does **not** accept the container, toolbar or pagination |
| `md-table-head` / `-body` / `-foot` | `md-table-row` |
| `md-table-row` | `md-table-cell`, plus `md-table-expand-toggle` for an expandable row |
| `md-table-cell` | `md-table-sort-label` in a header cell |
| `md-tooltip` | **its trigger** — the tooltip wraps the element it describes in its default slot |
| `md-dialog` | body content in the default slot; `md-button` in `slot="actions"` |
| `md-bottom-sheet` / `md-side-sheet` | content in the default slot; `md-button` in `slot="actions"`; headline in `slot="headline"` |
| `md-app-bar` | `md-icon-button` in `slot="leading"` and `slot="trailing"`; `md-menu` for overflow; a field in `slot="search"` on `variant="search"` |
| `md-toolbar` | `md-icon-button`, `md-button`, `md-button-group`; an `md-fab` in `slot="fab"`; `slot="leading"` / `slot="trailing"` for the end clusters |

### 7.2 Pairs that belong together

These don't nest — they sit next to each other in a working flow. Reaching for
one usually means you want the other.

| This | Goes with | Why |
|---|---|---|
| `md-icon-button` | `md-tooltip` | The tooltip supplies the visible meaning the icon lacks |
| `md-button` (`soft-disabled`) | `md-tooltip` | Explains *why* the action is unavailable |
| `md-fab` | `md-fab-menu` | The FAB is the menu's anchor |
| `md-split-button` | `md-menu` | The trailing half opens it |
| `md-card` | `md-button`, `md-icon-button`, `md-divider` | Footer actions, corner action, internal sections |
| `md-list-item` | `md-checkbox`, `md-switch`, `md-icon-button` | Trailing controls in a selectable or settings row |
| `md-bottom-sheet` / `md-side-sheet` | `md-list` | Action menus and filter panels inside the sheet |
| `md-search` | `md-list`, `md-avatar`, `md-icon-button` | Results in the panel; account and voice/filter affordances in the trailing slot |
| `md-date-picker` | `md-time-picker` | Date + time row for booking and scheduling forms |
| `md-time-picker` | `md-button` | The trigger, when `hide-trigger` is set. The picker **is** its own dialog — don't nest it in another one |
| `md-text-field` | `md-button` | Submit / cancel in the form footer |
| `md-multi-select` / `md-autocomplete` | `md-text-field`, `md-menu`, `md-chip` | The field is the trigger (and inherits its variant, density and error state), the menu is the option surface, chips are the selected values |
| `md-autocomplete` | `md-progress-indicator` | The loading row while suggestions are fetched |
| `md-transfer-list` | `md-checkbox`, `md-text-field`, `md-icon-button` | Per-row select, per-side search, mover controls |
| `md-number-field` | `md-text-field` hooks, `md-icon-button` | It *is* an `md-text-field` internally — every `--md-text-field-*` custom property passes through — and its steppers are `md-icon-button`s |
| `md-otp-field` | `md-button` | Verify action (`auto-submit` covers the no-button flow) |
| Any chart | `md-card` | Charts belong on a dashboard tile |
| `md-line-chart` | `md-segmented-button-set` | Period picker (1W / 1M / 1Y) driving the range |
| `md-sparkline` | `md-list-item`, `md-table-cell` | Trend column beside a value |
| `md-skeleton` | `md-card`, `md-list` | Render N placeholders in the real layout while fetching |
| `md-meter` | `md-chip`, `md-card` | Same semantic status colour on both; quota and usage summaries live on a card |
| `md-color-picker` | `md-text-field`, `md-button` | Label and helper text beside it in a form; save / cancel in the surrounding popover or dialog |
| `md-rating` | `md-text-field`, `md-card` | A rating row in a review form; aggregate scores on a review card |
| `md-accordion` | `md-divider` | Optional inner dividers inside long item content |
| `md-stepper` | `md-button` | Next / back / submit adjacent to the stepper |

### 7.3 Nesting that is always wrong

- A dialog opened from inside a dialog. Use `md-stepper` inside **one**
  `md-dialog`.
- A component inside a native interactive element (`<button>`, `<a>`) — it
  nests interactive controls and destroys the accessibility tree. Use the
  component's own `href` / `type` props.
- `md-tabs` used for top-level app navigation. Tabs switch sibling views of the
  same data; destinations are `md-navigation-bar` / `md-navigation-rail`.

---

## §8 — Page recipes

Complete, runnable screens. Each renders as-is once the components are
registered and the token sheet and font links from §3 are loaded — no
placeholder identifiers, no helper functions to write.

### 8.1 Login screen

`<form>` is load-bearing: it is what makes `required` block submit and what
`type="submit"` calls `requestSubmit()` on.

```html
<main style="display: grid; place-items: center; min-block-size: 100dvh; padding: 24px;">
  <form id="login-form" style="inline-size: min(420px, 100%);">
    <md-card variant="elevated" style="padding: 32px; display: flex; flex-direction: column; gap: 20px;">
      <h1 style="margin: 0; font: var(--md-sys-typescale-headline-medium-font);">Sign in</h1>

      <md-text-field
        variant="outlined"
        label="Email"
        type="email"
        name="email"
        autocomplete="username"
        required
      ></md-text-field>

      <md-text-field
        variant="outlined"
        label="Password"
        type="password"
        name="password"
        autocomplete="current-password"
        password-toggle="internal"
        required
      ></md-text-field>

      <md-button variant="filled" type="submit" full-width>Sign in</md-button>
      <md-button variant="text" href="/forgot-password">Forgot password?</md-button>
    </md-card>
  </form>
</main>

<script type="module">
  document.getElementById('login-form').addEventListener('submit', (e) => {
    e.preventDefault();
    const data = new FormData(e.currentTarget);
    console.log(data.get('email'), data.get('password'));
  });
</script>
```

### 8.2 Settings page (mobile)

Top app bar + grouped rows of instant-apply switches. `md-switch` uses
**`selected`**, not `checked`. The rows are `type="text"` (non-interactive), so
the switch is the only control — one tab stop per setting.

```html
<md-app-bar variant="small" headline="Settings">
  <md-icon-button slot="leading" icon="arrow_back" aria-label="Back"></md-icon-button>
</md-app-bar>

<main style="padding: 16px; display: flex; flex-direction: column; gap: 16px;">
  <md-card variant="outlined">
    <md-list>
      <md-list-item headline="Notifications" supporting-text="Push, email, in-app" lines="2">
        <md-switch slot="trailing" selected aria-label="Enable notifications" data-setting="notifications"></md-switch>
      </md-list-item>
      <md-divider></md-divider>
      <md-list-item headline="Dark mode" supporting-text="Match system" lines="2">
        <md-switch slot="trailing" aria-label="Enable dark mode" data-setting="dark"></md-switch>
      </md-list-item>
      <md-divider></md-divider>
      <md-list-item headline="Sync over cellular">
        <md-switch slot="trailing" selected aria-label="Sync over cellular" data-setting="cellular"></md-switch>
      </md-list-item>
    </md-list>
  </md-card>
</main>

<md-snackbar id="settings-toast" message="Setting saved"></md-snackbar>

<script type="module">
  const toast = document.getElementById('settings-toast');
  document.querySelectorAll('md-switch[data-setting]').forEach((sw) => {
    sw.addEventListener('mdChange', (e) => {
      if (sw.dataset.setting === 'dark') {
        document.documentElement.setAttribute('data-theme', e.detail.selected ? 'dark' : 'light');
      }
      toast.show();
    });
  });
</script>
```

### 8.3 Settings form (deferred save, with validation)

When settings are saved on submit rather than applied instantly, use a real
form. `required` blocks the submit; every control needs a `name` to reach
`FormData`.

```html
<form id="profile-form" style="max-inline-size: 560px; margin: 24px auto; padding: 0 16px;">
  <md-card variant="outlined" style="padding: 24px; display: flex; flex-direction: column; gap: 20px;">
    <h2 style="margin: 0; font: var(--md-sys-typescale-title-large-font);">Profile</h2>

    <md-text-field
      variant="outlined"
      label="Display name"
      name="displayName"
      required
      supporting-text="Shown on your public profile"
    ></md-text-field>

    <md-select variant="outlined" label="Language" name="language" value="en" required>
      <md-select-option value="en" label="English"></md-select-option>
      <md-select-option value="de" label="Deutsch"></md-select-option>
      <md-select-option value="ar" label="العربية"></md-select-option>
    </md-select>

    <!-- md-checkbox has NO label slot. It is a labelable, form-associated
         element: wrap it in a native <label> (which names it AND forwards
         clicks), or give the host an aria-label. Text between the tags is
         NOT rendered. -->
    <label style="display: inline-flex; align-items: center; gap: 12px; cursor: pointer;">
      <md-checkbox name="newsletter" value="yes" supporting-text="Monthly, no more"></md-checkbox>
      <span>Send me product news</span>
    </label>

    <div style="display: flex; gap: 8px; justify-content: flex-end;">
      <md-button variant="text" type="reset">Reset</md-button>
      <md-button variant="filled" type="submit">Save changes</md-button>
    </div>
  </md-card>
</form>

<md-snackbar id="saved-toast" message="Changes saved" action="Undo"></md-snackbar>

<script type="module">
  const form = document.getElementById('profile-form');
  const toast = document.getElementById('saved-toast');

  form.addEventListener('submit', (e) => {
    e.preventDefault();
    const data = Object.fromEntries(new FormData(form));
    console.log(data); // { displayName, language, newsletter? }
    toast.show();
  });

  toast.addEventListener('mdAction', () => form.reset());
</script>
```

### 8.4 Dashboard with a FAB

```html
<md-app-bar variant="medium" headline="Inbox">
  <md-icon-button slot="trailing" icon="search" aria-label="Search"></md-icon-button>
  <md-icon-button slot="trailing" icon="filter_list" aria-label="Filter"></md-icon-button>
</md-app-bar>

<main style="padding: 16px; display: grid; gap: 12px; grid-template-columns: repeat(auto-fill, minmax(260px, 1fr));">
  <md-card variant="filled" interactive style="padding: 16px;">
    <strong>Acme contract</strong>
    <p style="margin: 4px 0 0; color: var(--md-sys-color-on-surface-variant);">Renewal due in 5 days</p>
  </md-card>
  <md-card variant="filled" interactive style="padding: 16px;">
    <strong>Q4 report draft</strong>
    <p style="margin: 4px 0 0; color: var(--md-sys-color-on-surface-variant);">Shared by Alex</p>
  </md-card>
</main>

<md-fab
  icon="add"
  aria-label="New item"
  style="position: fixed; inset-block-end: 16px; inset-inline-end: 16px; z-index: var(--md-sys-z-index-navigation);"
></md-fab>
```

`inset-inline-end` (not `right`) is what keeps the FAB in the correct corner
under `dir="rtl"`.

### 8.5 Destructive confirmation dialog

`md-dialog` traps focus and returns it to the trigger on close — do not add your
own focus management. The error colouring goes through the button's own custom
properties, never a hex.

```html
<md-button id="open-delete" variant="outlined">Delete account</md-button>

<md-dialog id="confirm-delete" headline="Delete account?" icon="warning">
  <p style="margin: 0;">
    This will permanently delete your account and all associated data.
    This action cannot be undone.
  </p>
  <md-button id="cancel-delete" slot="actions" variant="text">Cancel</md-button>
  <md-button
    id="do-delete"
    slot="actions"
    variant="filled"
    style="--md-button-container-color: var(--md-sys-color-error);
           --md-button-label-color: var(--md-sys-color-on-error);"
  >Delete</md-button>
</md-dialog>

<script type="module">
  const dialog = document.getElementById('confirm-delete');
  document.getElementById('open-delete').addEventListener('mdClick', () => dialog.show());
  document.getElementById('cancel-delete').addEventListener('mdClick', () => dialog.close());
  document.getElementById('do-delete').addEventListener('mdClick', () => {
    dialog.close();
    // perform the deletion
  });
</script>
```

If you omit `slot="actions"` entirely, `md-dialog` renders its own Cancel / OK
pair (labels via `cancel-label` / `ok-label`) and closes itself.

### 8.6 Tabbed content page

`md-tab-panels` finds the nearest preceding `md-tabs` (or the one named by
`for`), follows its `mdTabChange`, and wires `aria-controls` /
`aria-labelledby` both ways. **No JavaScript is required**, and `md-tab` has no
`value` or `selected` prop — selection lives on `md-tabs` as `active-tab-index`.

```html
<md-tabs id="profile-tabs" aria-label="Profile sections" active-tab-index="0">
  <md-tab label="Posts"></md-tab>
  <md-tab label="Replies"></md-tab>
  <md-tab label="Likes" badge="3"></md-tab>
</md-tabs>

<md-tab-panels for="profile-tabs">
  <md-tab-panel style="padding: 16px;">
    <p style="margin: 0;">Your posts appear here.</p>
  </md-tab-panel>
  <md-tab-panel style="padding: 16px;">
    <p style="margin: 0;">Your replies appear here.</p>
  </md-tab-panel>
  <md-tab-panel style="padding: 16px;">
    <p style="margin: 0;">Posts you liked appear here.</p>
  </md-tab-panel>
</md-tab-panels>
```

To react to the switch (lazy-loading a panel, for example), listen on the tabs:

```js
document.getElementById('profile-tabs')
  .addEventListener('mdTabChange', (e) => console.log(e.detail.index, e.detail.previousIndex));
```

### 8.7 The full recipe library

Twenty-two more complete screens live in the documentation, each with a live
demo, the full markup, framework tabs, and production notes. When the user's
request matches one of these, read that page (append the slug to
`https://awc-ui.dev/recipes/`) instead of composing from scratch:

| Recipe slug | Screen |
|---|---|
| `two-factor-verification` | OTP entry, resend countdown, backup-codes dialog |
| `kpi-overview` | Stat tiles with sparklines + charts under a range switcher |
| `data-grid-console` | Bulk-action data table: filters, selection, undo |
| `server-fleet-status` | Table of hosts with meters, sparklines, status dots |
| `release-health-drilldown` | Table row → side-sheet master-detail with charts |
| `csv-import-wizard` | Stepper: upload, map columns, validate, import |
| `role-permission-assignment` | Transfer-list permissions with confirm dialog |
| `org-chart-explorer` | Searchable org chart with side-sheet profiles |
| `moderation-queue` | Verdict controls, confidence meter, card queue |
| `checkout-wizard` | Three-step commerce checkout with validation |
| `appointment-booking` | Date + time pickers inside a stepper flow |
| `survey-nps` | Paged survey using every input control |
| `notification-preferences` | Accordion × switch matrix, quiet hours |
| `app-shell` | Responsive rail/bar chrome, SSR-ready, zero CLS |
| `inbox-shell` | Three-zone list + reading-pane layout |
| `mobile-filter-sheet` | Bottom-sheet filters with applied-chip row |
| `product-reviews` | Rating input + per-star meter breakdown |
| `order-tracking` | Shipment timeline stepper with progress meter |
| `portfolio-markets` | Finance charts + holdings table + trade ticket |
| `pricing-page` | Plan cards, billing toggle, comparison table |
| `async-feedback-patterns` | Skeleton/progress/snackbar choreography rules |
| `charts-gallery` | Every chart component, live-retheming palette |

---

## §9 — Universal do's and don'ts

Apply to every component. Component-specific rules live in each manual.

### 9.1 API and styling

| ✅ Do | ❌ Don't |
|---|---|
| Use the custom element directly — it *is* the control, with its own `href` / `type` props | Wrap it in a native `<button>` / `<a>` (§7.3) |
| Set arrays and objects as **JS properties** (`el.items = [...]`) | Pass them as HTML attributes — they won't parse |
| Theme via `--md-<component>-*` properties, then `::part()` | Reach into shadow internals or override `.md-*` classes |
| Change appearance through design tokens (§4.1) | Hardcode hex colors, px spacing, shadows, or font stacks |
| Use `--md-sys-z-index-*` for your own overlays | Invent z-indexes that land under a menu |
| Use logical CSS (`margin-inline-start`, `inset-inline-end`) | Use `margin-left`, `right`, `padding-right` |
| Set `data-density` / `data-theme` / `dir` once, globally | Set them per component unless you mean a local exception |
| Listen to the component's `md*` events | Rely on native `click` — it fires even when the component's `disabled` / `loading` guard suppressed the action |
| Check the manual for the state prop name | Assume `checked`; `md-switch` uses `selected` |
| Render the element, then call its `@Method` | Call `.show()` on an element not yet in the DOM |

Toggling components flip their own state on activation and *then* emit. On
`md-button`, `mdClick` is cancelable — `preventDefault()` on it vetoes the
toggle and any navigation. `mdChange` fires after the flip and is not
cancelable. If a controlled parent rejects a change it must revert the child
explicitly.

`md-button` has a **toggle mode**: set `toggle` and the button flips its own
`selected` on each activation and exposes `aria-pressed`. `selected` is the
state, not the switch — set it for the initial pressed state and read it back
from `mdClick`'s `detail.selected`. Setting `toggle` and then styling
"pressed" yourself, or setting `selected` without `toggle` (which emits no
`aria-pressed` at all), both produce a control that lies to assistive tech.

### 9.2 Content and hierarchy

| ✅ Do | ❌ Don't |
|---|---|
| Use sentence case for all labels | Uppercase or title-case UI text |
| Keep one high-emphasis action per screen region | Compete `filled` buttons against each other |
| Use `soft-disabled` + `md-tooltip` for contextually-unavailable actions | Use `disabled` and remove it from tab order with no explanation |
| Localize every text prop and `aria-label` | Leave default English prop values in a translated app |

**`disabled` vs `soft-disabled`.** Both render the disabled appearance, but
`disabled` also removes the control from the tab order, so a keyboard or screen
reader user can never find out *why* it is off. `soft-disabled` keeps the
control focusable and announced while still blocking activation — which is what
lets an `md-tooltip` on it explain the gate. Use it whenever the reason is
informative rather than obvious.

Nesting rules — dialog inside a dialog, a component inside a native
`<button>` / `<a>`, tabs used as app navigation — live in §7.3.

### 9.3 Accessibility contract

The library ships WCAG 2.1 AA keyboard and ARIA wiring by default. These are the
rules you must not break:

1. **Every icon-only control gets an accessible name.** `md-icon-button`,
   `md-fab`, and icon-only `md-tab` are nameless without `aria-label` (or
   `aria-labelledby`). `md-fab` will also accept `label`, and warns in the
   console when it has neither.
2. **Every form field gets a `label` prop.** `placeholder` is not a label — it
   disappears on type.
3. **Don't break the tab order.** Every interactive control must be reachable by
   Tab and operable by Enter/Space. If you add `tabindex="-1"` to anything,
   have a reason.
4. **Don't write your own focus trap.** `md-dialog`, `md-bottom-sheet` and
   `md-side-sheet` trap focus while open and restore it to the trigger on
   close — including across shadow boundaries. Adding your own fights theirs.
5. **Don't wrap components in your own live regions.** `md-snackbar` announces
   itself (`politeness="polite"` by default, `"assertive"` when the message must
   interrupt). For an error that blocks the task, use `md-dialog`.
6. **Don't disable motion yourself.** Components honour
   `prefers-reduced-motion: reduce` internally.
7. **Directional icons do not auto-flip in RTL** — see §4.5.
8. **Re-verify contrast after overriding any colour role** — the library's AA
   testing covers the shipped palette only. The Theme Generator at
   <https://awc-ui.dev/theme-generator> runs the WCAG checks live (§4.2).

---

## §10 — Before you ship

1. **Every icon-only control has an accessible name.**
2. **Keyboard-only pass**: reach and operate every control; focus is always
   visible; no traps in dialogs/menus/sheets; focus returns to the trigger.
3. **Theme pass**: light *and* dark, if both are supported — and the attribute
   is set before first paint.
4. **RTL pass**, if an RTL locale ships — check directional icons specifically,
   and grep your own CSS for physical properties.
5. **Density pass** at the configured rung — no clipped labels, touch targets
   still adequate. Remember `density="0"` is inert; use
   `--md-sys-density-scale: 0` to opt a subtree out.
6. **Forms**: every control has a `name`; `required` blocks submit; `FormData`
   contains every field; reset works.
7. **No hardcoded strings** left in markup if the app is localized — including
   default prop values like `Search`, `Dismiss`, `No results`.
8. **No hardcoded design values** — grep the diff for hex colours, `px` radii,
   `box-shadow`, and `z-index` literals.
9. **Contrast** re-verified against AA if colour roles were overridden.
10. **SSR**: if server-rendered, confirm no hydration mismatch and that content
    is present with JS disabled.
11. **No shadow-internal CSS** — only tokens, custom properties, and `::part()`.
12. **Every `md-*` tag you emitted appears in §6.** If it doesn't, it doesn't
    exist.