@deriv-com/dds-marketing 0.1.0 → 0.2.0

package/.llm/components/menuitem.md

@@ -0,0 +1,218 @@
+<!-- GENERATED from menu-item.contract.json. Do not edit. -->
+
+# MenuItem
+
+One command in a menu. Pressing it does something and the menu shuts — it holds no value and carries no mark, so there is nothing about it to find on reopening.
+
+It ships ahead of its host, and that is worth saying plainly: its role is menuitem, which means nothing to a screen reader outside an element whose role is menu. On its own it is a row that looks right and announces wrong. DropdownMenu is what makes it a component rather than a fragment, and until that lands this is a contract and a stylesheet waiting for one.
+
+A marketing page reaches for a menu where a set of destinations is too long to sit in the navigation and too short to deserve a page — the languages a site is published in, the pages a long index skipped over. Not for a toolbar of operations: a page has nothing to operate on, which is the whole difference from the menus an application builds.
+
+## Use when
+
+- A row in a menu of destinations — a language, a region, a page number an index skipped
+- A set short enough to read at a glance, where a reader is choosing rather than searching
+
+## Do not use
+
+- The row reports a choice the reader should find marked when they return → nothing here does this
+- The destination belongs in the page's navigation → nothing here does this
+- It is one action rather than one of a set → nothing here does this
+- Anything that destroys. Marketing has no destructive tone by decision — a page navigates a visitor toward a conversion and never deletes on their behalf
+- Carrying the words a reader needs before choosing. A row is a short label; what a choice means belongs on the page, where it can be read without opening anything
+
+## Anatomy
+
+MenuItem renders 3 elements. A token binding names the part it applies to.
+
+- `root` — `<li>`, class `dds-menuitem`. The row, announced as a command. A list item because its parent draws a list, and a menu item because its parent is a menu — the two together are what let a screen reader say "menu, three items" and then "Rename, menu item".
+  
+  It takes real focus rather than being described from somewhere else, which is the difference between a menu and a Select: an Option is pointed at from the field that holds the answer, and a command is the thing a reader is on when they press Enter. So the row is focusable, and the ring around it is the browser’s own.
+  
+  Declared focusable, because it is: the implementation gives it `tabindex="-1"` and moves focus to it with the arrow keys. Without saying so the contract would be binding a focus ring to an <li>, which takes no focus of its own — a rule the browser emits and discards, and a check that says so before anybody looks for the ring that never appeared.
+  
+  Two sizes, and the menu picks. A row never sizes itself — DropdownMenu does, passing its own size to every row it renders, because the menu is the only thing that knows what the set is. The step is the row's type and nothing else. The inset is the same at both, and deliberately: the corner is `radius.menu-item`, which answers to the surface the row sits in rather than to the control ramp, so it cannot follow the size — and a shorter row under a corner that stays put is a row that reads as a pill. Holding the inset keeps the two steps near the proportion product's own row has, and keeps the first and last rows concentric with the panel at either size. This axis was withheld while there was no menu to set it — the note here read that the day it needed two, both components would gain the axis together, and that is what happened.
+- `icon` — `<span>`, class `dds-menuitem__icon`. The mark before the words. It takes its colour from the row, so a destructive command’s mark goes red with its words rather than being coloured separately — one decision, stated once. Rendered only when `icon` is set.
+- `label` — `<span>`, class `dds-menuitem__label`. The command itself. One line, cut at the end rather than wrapped: a menu is read down its left edge, and a row that wraps to two lines breaks the rhythm a reader is scanning by. A command long enough to be cut is a command that wanted fewer words.
+
+Apply these classes from the generated `menuItemParts` constant rather than writing the strings by hand.
+
+## Composition
+
+- Can contain: `text`
+- Never contains: `Button`, `Card`, `CardButton`, `DropdownMenu`, `TextInput` — in children or in any prop that takes a node
+
+## Props
+
+### size — `sm` | `md` (default `md`)
+
+- `sm` — The row of a small menu — one opened from a navigation bar or a footer, where the trigger sits in a row of links
+- `md` — The default, and the row of every other menu
+
+Use when: Set by the menu that holds the row, not by the page. DropdownMenu passes its own size down to every row it renders, which is the only way a set stays one set — this prop exists so that it can, and a row written on its own takes the default
+Never for: Making one row bigger than its neighbours. A menu is read by running an eye down its left edge, and a row at a different measure reads as a heading rather than as one of the set
+
+### disabled — `boolean` (default `false`)
+
+Use when: The command cannot be used from here — a language not published yet, a page beyond the set. It stays and recedes, because a menu whose rows come and go is a menu a reader cannot learn
+Never for: A command that is simply not applicable to this object at all, which belongs in a different menu rather than a dimmed row in this one. And it names the tone as well as itself, deliberately: a destructive command that cannot be pressed goes grey like any other, because dimming red leaves a pale red that still shouts danger while offering nothing to press
+
+### icon — `node`
+
+Accepts: QuillSystemIcon
+Use when: A mark before the words, for a set read by shape as much as by reading — a flag beside a language, a glyph beside a region. All of them or none: one row with a mark in a set without them reads as the important one
+Never for: Saying what the command does when the words already do. A mark beside "Delete" is recognised faster; a mark beside "Export to CSV as a background job" is decoration in front of a sentence
+
+### onSelect — `callback` **Required.**
+
+Use when: Always, and it is required for that reason — running something is the whole of what a command is, and this is the only way it does
+Never for: Shutting the menu. That happens on its own, before this is called — a command that had to close its own menu would be a command every page closed differently. And there is no case for leaving it out: a row that shuts the menu and does nothing is the clearest promise a menu can break, and the reader presses it twice before deciding the page is at fault
+
+Also accepts everything from `LiHTMLAttributes<HTMLLIElement>`.
+
+## Accessibility
+
+Guaranteed by the component. Write none of it by hand: the ids these attributes point at are generated per instance, so an attribute set from outside either says the same thing twice or points at nothing.
+
+- Announced as: `menuitem`
+- `Enter or Space` — run the command, which shuts the menu first and returns focus to the trigger
+- `ArrowUp or ArrowDown` — the previous or next command. Handled by the menu rather than by the row, because moving between rows is a fact about the set
+- it takes real focus, and the ring is the browser’s own. A command is the thing a reader is on when they press Enter — where an Option is pointed at from the field holding the answer, because focus there belongs to the box
+- a command that cannot be used is announced as unavailable and stays in the menu, rather than being removed. A set that changes shape between openings is one a reader has to learn twice
+- the destructive tone is a colour and nothing else, so it is not the only thing saying what the command does. The words carry that — "Delete" says it, and red only says it sooner
+- the mark before the words is decorative, the words saying the same thing. A mark that had to be read would be a command whose name was a picture
+
+## Rules
+
+- **On a phone a section's actions stack and each fills the width, including when there is only one** — On a phone a page's actions stack, and each one fills the width. Not most of it, and not the width its label happens to need — the whole column.
+
+Two side by side is what this replaces. On the narrowest screen each gets half a column minus the gap, which is rarely enough for a real label: the words wrap inside the pills, the two buttons come out different heights, and the pair reads as a broken row rather than as a choice. Stacked, each has the whole width and neither has to shorten its words to fit.
+
+A single action fills too, and that is the part worth saying, because it is the one that looks unnecessary. A lone button has the room to sit at its natural width and still should not: a full-width control is the phone's convention for the thing the screen is asking you to do, and a pill hugging its label reads as one option among others that are not there. It also makes the target predictable — the whole width, wherever the thumb lands — which a centred pill does not.
+
+Filling is the row's job rather than the button's. A button has no width of its own and is not given one; the row it sits in becomes a column and stretches its children, so nothing about the control changes and the same button is full width here and its own size on a desktop.
+
+This is the phone's breakpoint, size.breakpoint.md, and not the wider one that decides whether a heading is centred. Those are different questions and they break at different widths: a heading stops being centred when the measure is the screen, while a button stops being full width much sooner than that — stretched across a tablet it is a long way from its own label, and a label centred in a metre of pill is harder to hit than one in a pill the size of the words.
+
+What this is not about is every row of controls. A set of filter chips, a pagination strip, a toolbar, a link sitting after a sentence — none of these is the page asking for something, and stacking them to full width would turn a strip the eye skims into a list it has to read. The test is whether the row is the call to action the section was written for.
+  Guidance only — cannot be checked automatically.
+- **Never nest one interactive element inside another** — Nested interactive elements produce ambiguous hit targets and an unreachable inner control for keyboard and screen-reader users. This is why the rule cannot live on any single component — it constrains Button, Link, Input and Switch simultaneously.
+  Guidance only — cannot be checked automatically.
+- **A section that paints a ground sets the ink to go with it** — A page sits on color.bg.page, and a section that separates itself from it takes one of three grounds. color.bg.subtle is the light one and needs nothing further — the page's own ink still reads on it. The other two are dark and do not: color.bg.brand-strong takes color.fg.on-brand-strong, and color.bg.brand takes color.fg.on-solid. Both are white, and both are written as the role rather than the white they resolve to. Set one of those backgrounds without its ink and the text inherits whatever the page was already using, which is near-black on a dark band — legible to nobody, and invisible to every check here, because each pair passes contrast on its own and nothing can tell whether a section used both.
+
+color.bg.brand carries a second limit that is not about forgetting. Its ink measures 3.39:1, which clears the 3:1 a heading needs and misses the 4.5:1 running copy needs. A coral band may carry a headline and a call to action; a paragraph on one is text the reader has to work through at a ratio the waiver on that role does not cover — the waiver says so itself. A section with copy in it takes color.bg.brand-strong, which is near-black and carries white at full contrast.
+
+color.bg.strong is not a section ground. It is the inverted fill for an action that has to outrank what surrounds it, and the components that paint it — Button and ButtonIcon in their inverse form — already set both halves in one rule, which is the pattern a hand-painted section has to copy.
+  Guidance only — cannot be checked automatically.
+- **Every gap inside a section names the relationship it expresses, and the same relationship keeps its measure when it turns on its side** — A section's spacing is named by the relationship it expresses, not chosen by size. Every gap in a section has a role token, and reaching for a step off the generic scale because it happens to be the right number is how two sections written by two people stop lining up: the numbers agree today and drift the first time one of them is tuned.
+
+The heading group is three steps, not one gap. An eyebrow sits nearer its title than the title sits to its description, and the actions sit further from the description than either — space.heading.eyebrow-title, space.heading.title-description, space.heading.description-actions, in that order. A single `gap` on the group cannot say this; it sets all three the same and the block reads as evenly spaced lines rather than as a mark, a name and a paragraph. The eyebrow has to identify itself for this to work, because a group that opens with a title must not give its description the eyebrow's tighter step.
+
+The step between a title and its description follows the size of the title, which is why there are two of it. What a reader sees is not the gap but the gap plus the leading above it, and leading scales with the type: under a display title the leading is most of the space, under a card's title it is half as deep. One value for both makes a card look loose at the size that made a section look right. So space.heading.title-description is the display step and space.heading.title-description-compact is the step at a card's size, and the choice is made by how big the title is rather than by what kind of block it sits in.
+
+Every one of those steps is smaller than the gap below the group, and that ordering is what holds the group together as one thing. space.heading.content is the step between a heading group and the content it introduces, and it is the widest measure inside a section: the one gap the eye reads as a change of subject rather than as a continuation.
+
+That step is the same whether the content is under the heading or beside it. A split is the same relationship turned on its side — a heading group and the content it introduces — so the space between the two halves is space.heading.content, not a gutter. When the split collapses to one column on a phone the gap becomes vertical again, which is where it started, and nothing has to change for that to be right.
+
+space.grid.gutter is between two things of the same kind. Two cards in a row are the same kind; the two halves of a split are not, which is why the gutter is the wrong measure there even when the number would have looked acceptable. The gutter runs on both axes, so a grid reads as an even field rather than as rows with a seam down them.
+
+space.inset.card is the card's, not the page's. A row of cards padded differently is a row of different cards, and the fill is the only edge they have. A page composing a row does not get to choose it.
+
+Column count is not a breakpoint decision. A row holds as many columns as fit before a column would be narrower than size.grid.column-min, and drops one when they would not. Written as a fixed count that collapses at a breakpoint, a four-up row keeps four columns at every width above the phone and sets its copy two or three words to a line through the whole of the tablet range — and on a narrow desktop, which no breakpoint sits on at all. The threshold is a property of the row rather than of a card: a card fills whatever cell it is given.
+
+What this does not cover is the space above and below a section, which is space.section.default and space.section.compact, and the page's own side margin, which is space.inset.page. Those are the section's outside; everything here is its inside.
+  Guidance only — cannot be checked automatically.
+- **A section's title is centred over stacked content, starts beside content in columns, and starts on a phone** — Two arrangements, and the title's alignment is decided by which one it is introducing rather than chosen per section.
+
+Content stacked under the title — a row of cards, an accordion, a set of steps — takes a centred title. The heading group and the block below it share one axis, so a centred title is symmetric with the thing it names, and the eye drops from the middle of the words to the middle of the set. A title starting at the left over a centred or full-width block reads as belonging to the first column rather than to all of them.
+
+Content beside the title — a split, a picture in the other half, anything laid out in columns — takes a title that starts where its content starts. The two share a left edge, and that edge is what says they are one thing read across rather than two stacked. Centring the title there breaks the only alignment the reader has to hold the halves together, and it drifts further from its content the wider the page gets.
+
+The heading group is what carries this, not the heading alone. An eyebrow, a title and a description are read as one block and align together; aligning the title without them leaves a centred heading over start-aligned copy, which reads as a mistake rather than as a choice.
+
+Centred means all of it, not just the words. A badge, a row of actions, a picture — these are flex children, and a flex child is placed by align-items rather than by text-align, so a block that only sets the text leaves everything that is not text at the start. A hero is the case that shows it: its title and copy centred while its badge and its buttons did not.
+
+A capped block centres itself as well as its words. A heading group takes size.heading-group.max, and a cap that is not centred leaves the measure at the start of the column with the words centred inside it — composed, and a long way left of the middle it appears to be in.
+
+Both arrangements go to the start on a phone. A centred block reverts below the breakpoint, and the reason is the measure: on a phone the measure is the screen, so a centred title wraps to three or four ragged lines and the eye loses the left edge it was tracking — the same symmetry that reads as composure on a desktop is what makes it hard to scan on a phone. Centring there has to be asked for twice, and a section title is not one of the things that asks: it is centred because there is room for it, and on a phone there is not. Going back to the start means all of it too, and a capped block is the one that hides a leftover: its words go to the start while its measure stays in the middle of the column, which reads as a title still centred over a badge and buttons that are not — the box in the middle and the line inside it at the edge.
+
+A hero is a section like any other: its badge, title, copy and actions are one stacked block, so it is centred on a desktop and starts on a phone with everything else.
+
+What this is not about is a page whose body is a form or a document. A title over a sign-up form or a guide is not introducing a set of content — it is the first line of the thing itself, and it keeps the alignment the body has, which for running text is the start. The distinction is whether the block below is content the title names or content the title is part of.
+  Guidance only — cannot be checked automatically.
+- **Anything a pointer has to hit is at least 24px in both directions** — A control sized by its contents is as big as its contents, and a glyph is chosen for how it reads rather than for how easily it is hit. An icon-only button with no padding is a 16px target — smaller than the pad of a finger, and smaller than the tremor of a hand using a mouse.
+
+WCAG 2.2 asks for 24 by 24 CSS pixels at AA. The exceptions are narrower than they look: inline targets inside a sentence are exempt, and so is a small target with 24px of clear space around it — but a clear button sits against the field it empties, and a field is itself a target, so the spacing exemption does not apply to the case that keeps arising.
+
+The target and the mark are separate decisions, and conflating them is what produces both faults. Growing the glyph to 24px makes it shout; leaving the button at 16px makes it hard to hit. So the glyph keeps the size that reads correctly beside its text, and the box around it declares a minimum of its own — which is what size.target.min is for.
+
+Declared rather than emergent. Padding plus contents does clear 24px in several components today, and it is the weaker statement: it is a size nobody wrote down, so it moves when the type scale or the glyph does, and nothing says it was meant to be a target at all.
+  Guidance only — cannot be checked automatically.
+
+## Anti-examples
+
+❌ MenuItem for: The row reports a choice the reader should find marked when they return
+   Nothing here does this yet. A command holds no value, so a menu of them cannot show which one is current — a language picker that forgets the language is a picker that has not picked.
+   → nothing in this system does this. Not a gap waiting to be filled — the case belongs outside it.
+
+❌ MenuItem for: The destination belongs in the page's navigation
+   A menu is where a reader goes when the navigation could not carry something, not a way to avoid writing one. Links in a nav are found; commands in a menu are looked for.
+   → nothing in this system does this. Not a gap waiting to be filled — the case belongs outside it.
+
+❌ MenuItem for: It is one action rather than one of a set
+   Button. A menu holding a single command is a button wearing a panel, and it costs the reader a press to discover that.
+   → nothing in this system does this. Not a gap waiting to be filled — the case belongs outside it.
+
+## Example
+
+```tsx
+import { MenuItem } from '@deriv-com/dds-marketing'
+import { GlobeRegularIcon } from '@deriv-com/quill-icons-web'
+
+<MenuItem onSelect={() => { /* your handler */ }} icon={<GlobeRegularIcon />}>English</MenuItem>
+```
+
+## In use
+
+### A set of destinations
+
+The rows a marketing menu holds: short labels a reader chooses between, not operations on something. One mark each or none at all.
+
+```tsx
+import { MenuItem } from '@deriv-com/dds-marketing'
+import { GlobeRegularIcon } from '@deriv-com/quill-icons-web'
+
+// With a mark, for a set read by shape
+<MenuItem onSelect={() => { /* your handler */ }} icon={<GlobeRegularIcon />}>English</MenuItem>
+
+// Words alone, which most sets are
+<MenuItem onSelect={() => { /* your handler */ }}>Deutsch</MenuItem>
+```
+
+### Unavailable
+
+It stays in the menu and recedes. A menu whose rows come and go is one a reader cannot learn, so an unavailable row is announced rather than removed.
+
+```tsx
+import { MenuItem } from '@deriv-com/dds-marketing'
+
+// disabled — announced, not removed
+<MenuItem onSelect={() => { /* your handler */ }} disabled>Français</MenuItem>
+
+// beside the ones that work
+<MenuItem onSelect={() => { /* your handler */ }}>English</MenuItem>
+```
+
+### Two sizes
+
+The menu sets this, never the row. The type steps and the inset does not — the corner cannot follow the size, and a shorter row under a fixed corner reads as a pill.
+
+```tsx
+import { MenuItem } from '@deriv-com/dds-marketing'
+
+// sm — a menu opened from a footer row
+<MenuItem onSelect={() => { /* your handler */ }} size="sm">English</MenuItem>
+
+// md — the default row
+<MenuItem onSelect={() => { /* your handler */ }} size="md">English</MenuItem>
+```