@deriv-com/dds-marketing 0.1.0 → 0.2.0

package/.llm/components/option.md

@@ -0,0 +1,268 @@
+<!-- GENERATED from option.contract.json. Do not edit. -->
+
+# Option
+
+One answer on offer inside a control that opens a list. It knows what it is worth and what to call itself, and nothing about where it sits — whether it is the answer, whether the arrow keys are on it, and how tall to be are all passed down, because only the control can see the set. One row for every such control rather than one per control: what differs between one chip and the next is the trigger, never the row.
+
+## Use when
+
+- An answer inside a control that opens a list — a SelectChip today. One of these per option in the set
+
+## Do not use
+
+- Pressing it should do something rather than record an answer → `MenuItem`
+- The row is one of a few and all of them fit on the page → `FilterChip`
+- Anything outside a list that a control owns. It is an <li> announced as an option, which means nothing without that list — a screen reader meeting one loose reports a bare list item
+- A heading over a group of answers, or a line between two groups. A row announced as an option that cannot be taken is a dead end the reader has to arrow past, and they will try it first
+
+## Anatomy
+
+Option renders 6 elements. A token binding names the part it applies to.
+
+- `root` — `<li>`, class `dds-option`. The row, and the whole of the target. The words, the mark and the space around them all belong to it, so there is no part of a row that looks choosable and is not — the fault a row built out of a padded label always has. It fills the list rather than hugging its own words, which is what makes the tint behind it a band across the list instead of a shape around a name. Its height is a floor rather than a height, so a row carrying a description is as tall as its two lines need, which is why it has block padding at all. It paints one thing, and only one: where the reader is. What they chose is said by the words and the mark, so the background has a single meaning and needs no ranking against anything.
+- `leading-icon` — `<span>`, class `dds-option__leading-icon`. A mark before the name, for a set the reader knows by sight — a flag on a language, a glyph on a market. It is read faster than a name is, which is the whole of what it is for: in a set somebody has met before, recognising beats reading. Centred against the row rather than against the first line, because the row is one line or two and the mark belongs to the answer rather than to a line of it. It binds no colour, so it takes the ink of the words beside it and follows them wherever a state takes them. Rendered only when `leadingIcon` is set.
+- `text` — `<span>`, class `dds-option__text`. The words, stacked. A column rather than the row's own children, because a description sits under the name rather than after it, and the mark has to stay beside both rather than beside the last line of them. It is what shrinks when the row is narrow, and it is where the permission to shrink lives: each line clips itself, but a line can only clip inside a box that is allowed to be smaller than its contents.
+- `label` — `<span>`, class `dds-option__label`. What the reader chooses by — a noun phrase in sentence case, naming the answer rather than instructing anybody to take it. One line, cut at its end: a row that wrapped would move every row beneath it, and it would do that while somebody was arrowing down through them. The answer's words are set in the weight the chip sets its value in, and that is the point of it rather than a decoration: this row becomes that value the moment it is taken, so the two being the same words at the same weight is one fact stated once. In this package that weight is the label role, which is the semibold step the chip's own trigger already uses — product reaches for a body-strong ramp this package does not have, and arrives at the same place.
+- `description` — `<span>`, class `dds-option__description`. What the name does not say on its own — a code, a rate, where an answer applies. Quieter than the name and read second or not at all: a reader who recognises the name never has to reach it. One line, cut at its end, for the reason the name is. Which makes this a place for a phrase rather than a sentence — anything needing two lines is guidance about the control and belongs beside it, where it is read once instead of once per answer. It reaches the accessible name along with the label, and deliberately: a reader who cannot see the list should hear what distinguishes two answers.
+  
+  It takes no colour of its own, so it comes out the same ink as the label above it. Neither binds a default colour — both inherit — which is what makes the pair agree on any ground rather than only on the one they were drawn against. Size is what separates them, and size is enough: a label at body-md over a description at body-sm is already a hierarchy, and setting the second one a step lighter as well says it is an aside. A description is not an aside — it is the half of the pair that says what the thing actually is. Rendered only when `description` is set.
+- `tick` — `<span>`, class `dds-option__tick`. The mark on the answer already taken. A list has two things to say at once — which row is the answer, and which row the reader is about to take — and a background can only say one of them. So the background says where the reader is and this says what they chose. The slot keeps its width whether or not the mark is in it: the words beside it cut themselves off at the end, so a slot appearing on selection would take that width away mid-list and move the ellipsis of every long name the reader was weighing up. It binds no colour, which leaves the mark the same ink as the words it belongs to.
+
+Apply these classes from the generated `optionParts` constant rather than writing the strings by hand.
+
+## Composition
+
+- Can contain: `text`
+- Never contains: `Button`, `Link`, `TextInput`, `MenuItem`, `FilterChip` — in children or in any prop that takes a node
+
+## Props
+
+### size — `sm` | `md` (default `sm`)
+
+- `sm` — The default, and the step a SelectChip at its own default opens
+- `md` — Touch-first, where the row is also the target and a finger has to land inside it
+
+Use when: Set by the control so the list matches the chip it hangs from. A row is as tall as the control it opened from, which is what makes the list read as the chip opened rather than as a separate thing beneath it
+Never for: Varying within one list. Rows of two heights in one set read as two lists that happen to touch
+
+### selected — `boolean` (default `false`)
+
+Use when: Set by the control that owns the list, not by a page. The row has to say it is the answer and carry aria-selected, and both are facts about the set rather than about the row — a page setting this directly would be claiming an answer the control does not think it has. It is said by the words and the mark rather than by a ground, which leaves the background to mean one thing only
+Never for: Marking a recommended answer. Chosen means the reader chose it, and a row that arrives already marked implies an act nobody took
+
+### active — `boolean` (default `false`)
+
+Use when: Whether the arrow keys are resting here. The control's to set: only the control knows where the keys are, and only one row can be right at a time. It brings the same ground a pointer brings, because they are the same fact in two input modes and a reader should not have to learn two marks for it
+Never for: Marking the answer. That is selected, and a ground saying both would have to rank one against the other
+
+### disabled — `boolean` (default `false`)
+
+Use when: This one answer cannot be taken. The row stays in the list and stays readable, because a set that hides what it will not accept leaves the reader hunting for something that was there last week
+Never for: Most of the set. A list where nearly nothing can be taken is the wrong list, and a row that simply refuses does not say why
+
+### value — `string` **Required.**
+
+Use when: What the control reports when this row is taken. A stable code rather than the words, so the words can be reworded or translated without changing what anything submits
+Never for: The words themselves, where they happen to look like a code. "EN" reads as both and is one of them — a value that doubles as a label is a value nobody can change later
+
+### leadingIcon — `node`
+
+Accepts: QuillSystemIcon
+Use when: A mark the reader knows the answer by — a flag on a language, a glyph on a market. For a set met before, where recognising is faster than reading. Pass the glyph itself rather than one already wrapped in an Icon: the row wraps it at icon.size.xs on sm and icon.size.sm on md, and the tick at the other end takes the same ramp so the two marks are one size
+Never for: Decoration, or a set where the names are the only thing telling the answers apart — a column of marks that all mean "an option" costs an indent down the whole list and buys nothing. And never for anything pressable: a control inside a row is a tab stop the pattern has no room for
+
+### description — `string`
+
+Use when: What the name does not say on its own — a code beside a market, where an answer applies. Give it where two answers are hard to tell apart by name, and leave it out where the name is the whole of the answer
+Never for: Guidance about the control, which belongs beside it: written here it is read once per answer instead of once. Nor a sentence — this is one line and cut at its end, so anything long arrives truncated and says less than nothing
+
+## Choosing a variant
+
+Placement in, props out. When one of these describes what you are building, take
+its props — do not re-derive them from the variant descriptions above.
+
+- **The answers inside a SelectChip** — `selected`
+  One per answer in the set. The chip sets selected, active and size on every row, because only the chip can see the set — a row deciding any of them for itself would be claiming a fact it cannot check
+
+## 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: `option`
+- aria-selected on every row, whether or not it is the answer. A row without it is one a screen reader cannot place in the set — "false" is what says the others were looked at and are not it
+- the row takes no focus of its own. Focus stays on the control while the list is open, and the active row is pointed at rather than moved to — a row that took focus would leave the control unable to say which answer the keys are on
+
+## 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
+
+❌ Option for: Pressing it should do something rather than record an answer
+   An answer is a value the control carries and shows back when shut. A row that acts on press belongs to a menu, and a menu keeps its own name whatever was pressed — the difference reaches a screen reader as two different roles
+   → use `MenuItem` instead.
+
+❌ Option for: The row is one of a few and all of them fit on the page
+   A chip each shows every narrowing at once and answers in one press, where a list costs a press to open before anything can be read. Folding is worth it only when the row cannot hold the set
+   → use `FilterChip` instead.
+
+❌ disabled=true + state=hover
+   A row that cannot be taken does not answer the pointer, so there is no ground for it to take. A styling-matrix exemption rather than an API constraint — disabled is a real value and hover is a real state; what does not exist is a treatment for the two together, and one would light up an answer the reader cannot give
+
+## Example
+
+```tsx
+import { Option } from '@deriv-com/dds-marketing'
+
+<Option value="newest" selected>Newest first</Option>
+```
+
+## In use
+
+### What a row can be saying
+
+Two facts at once, and a background can carry only one. So the ground says where the reader is, and the words and the tick say what they chose.
+
+```tsx
+import { Option } from '@deriv-com/dds-marketing'
+
+// On offer
+<Option value="oldest">Oldest first</Option>
+
+// Chosen — the weight the chip shows its value in
+<Option value="newest" selected>Newest first</Option>
+
+// Where the arrow keys are resting
+<Option value="popular" active>Most read</Option>
+
+// Chosen, and the keys are on it
+<Option value="newest" selected active>Newest first</Option>
+```
+
+### A line under the name
+
+What the name does not say on its own. Quieter and read second or not at all — a reader who recognises the name never has to reach it.
+
+```tsx
+import { Option } from '@deriv-com/dds-marketing'
+
+// Two answers hard to tell apart by name alone
+<Option value="eu" description="27 markets">Europe</Option>
+
+// The same row, chosen
+<Option value="apac" description="14 markets" selected>Asia Pacific</Option>
+```
+
+### A mark before the name
+
+For a set the reader knows by sight, where recognising beats reading. It takes the ink of the words beside it, so it follows them wherever a state goes.
+
+```tsx
+import { Option } from '@deriv-com/dds-marketing'
+import { ChartCandlestickRegularIcon, CoinsRegularIcon } from '@deriv-com/quill-icons-web'
+
+// A glyph the answer is known by
+<Option value="forex" leadingIcon={<ChartCandlestickRegularIcon />}>Forex</Option>
+
+// With a line under it as well
+<Option value="stocks" description="Major indices" leadingIcon={<CoinsRegularIcon />}>Stocks</Option>
+```
+
+### Longer than the row
+
+One line, cut at its end. A row that wrapped would move every row beneath it, and it would do that while somebody was arrowing down through them.
+
+```tsx
+import { Option } from '@deriv-com/dds-marketing'
+
+// Cut rather than wrapped
+<Option value="latam" description="Every market in the region, including the ones opening next quarter">Latin America and the Caribbean islands</Option>
+```
+
+### An answer that cannot be taken
+
+It stays in the list and stays readable: a set that hides what it will not accept leaves the reader hunting for something that was there last week.
+
+```tsx
+import { Option } from '@deriv-com/dds-marketing'
+
+// Not open to this account
+<Option value="crypto" disabled>Crypto</Option>
+```
+
+### Sizes
+
+Set by the control so the list matches the chip it hangs from. A row is as tall as the control it opened from.
+
+```tsx
+import { Option } from '@deriv-com/dds-marketing'
+
+// sm — the default
+<Option value="newest" size="sm">Newest first</Option>
+
+// md — touch-first
+<Option value="newest" size="md">Newest first</Option>
+```