@deriv-com/dds-marketing 0.1.0 → 0.2.0

package/.llm/components/tab.md

@@ -0,0 +1,291 @@
+<!-- GENERATED from tab.contract.json. Do not edit. -->
+
+# Tab
+
+One item in a strip, naming a version of what the page is already about. It cannot stand on its own: selected means selected against something, and a tab with no siblings is a heading that highlights.
+
+It is a control and not a link. Pressing it changes which slice of this page is showing — it does not go anywhere, there is no route behind it, and nothing about the page is different afterwards except which of two comparable things the reader is looking at. That is the whole difference from Product's Tab, which names a facet of a view an app holds state for.
+
+## Use when
+
+- One of a small set of comparable versions of the same offer — a billing period, a platform, a market class
+- The strip is the page's own comparison control and the alternatives are already written on the page
+
+## Do not use
+
+- Pressing it should take the reader to another page → `Button`
+- The item is one of a list of separate topics rather than a version of one → `AccordionItem`
+- Navigation. Nothing here carries an href and nothing should — a tab that goes somewhere has told the reader it would come back
+- A step in a sequence. A strip says its members are alternatives, and a reader may press the third without the first
+- The only tab. One tab is a heading, and a selected state that nothing is selected against says nothing
+- Hiding something the page needs read. A reader skimming a landing page does not press anything, so whatever sits behind an unselected tab is, for most visitors, not on the page at all
+
+## Anatomy
+
+Tab renders 7 elements. A token binding names the part it applies to.
+
+- `root` — `<button>`, class `dds-tab`. The item and the target, and a column rather than a box: the surface is the pill the pointer lands on and the strip's bar sits under it, so the two stack.
+  
+  A <button> because pressing it changes what is showing on this page rather than going anywhere — an anchor would offer a destination in the status bar and open a duplicate of the current page on a middle click. `type="button"` is set by the implementation: a bare button inside a form submits it, and a comparison strip inside a signup form is an ordinary place for this to be.
+  
+  It draws nothing itself. No fill, no border, no padding — every mark belongs to a part inside it, which is what lets the pill hug the words while the tab's own box fills the row's height. Product's Tab is built the same way and this follows it deliberately: the shape is the same shape, and only the values under it are Marketing's.
+- `surface` — `<span>`, class `dds-tab__surface`. The pill, and the only thing here the pointer changes. It takes `color.bg.hover` on hover — the ground arriving under the words is what says a tab is pressable, and it is the whole of the hover feedback because a tab that also moved or grew would be a button.
+  
+  `size.control.md` tall at `radius.control.md`, which is ten — a quarter of that height. The ramp has three control corners rather than one so the curve reads the same at every size, and the quarter is the ratio each of them holds. The softer reading this package is known for sits in its surfaces now rather than its controls: surface is 24 where Product's is 12, container 32, expressive 48. There is still one size here and no axis to choose it with; the corner belongs to the height.
+  
+  It must not refuse the pointer. Its children are inert so that a click landing on the label reports the surface underneath — a surface that refused the pointer itself would never be hovered, and its ground would be dead CSS.
+- `content` — `<span>`, class `dds-tab__content`. The row inside the pill: the glyph, the words, and the mark if there is one. It is the box the strip measures its bar against rather than the tab or the pill — the bar is as wide as what is written, so it does not run out under the padding either side.
+- `icon` — `<span>`, class `dds-tab__icon`. The glyph, when a mark tells the tabs apart faster than a word does — a platform, a market class. A <span> around it rather than the glyph itself, because Icon clones onto the SVG and this part is the place in the row.
+  
+  It takes the same ink as the label and changes with it, so a current tab is current in both. The size is Icon's: the tab hands it `sm` and an Icon arriving already sized is unwrapped rather than obeyed.
+  
+  Solid when current and regular otherwise, which this component cannot do for you — a Quill glyph's weight is fixed at the import. That is the package's `icon-solid-marks-selection` rule, and it is a rule rather than an axis for exactly that reason. Rendered only when `icon` is set.
+- `label` — `<span>`, class `dds-tab__label`. The words, and where selection is actually carried. The ink steps from `fg.muted` to `fg.default` and the weight from `font.body.md` to `font.label.md` — 400 to 600.
+  
+  Product steps 400 to 500, because Product's type set has a medium. This one does not: Marketing has one weight per role and `label` is 600 throughout, so the step here is the larger of the two. It is the same decision — the current tab is heavier — landing on the only weight the package owns.
+  
+  Its own part rather than bare text, unlike Badge's label. Here the type step has to land on the words and not on the glyph or the badge beside them, and the weight has to change without the row's other items changing with it.
+  
+  It is sized by the bold copy it carries rather than by the words it is showing — see `sizer`, which is what keeps a tab from growing when it is pressed.
+- `sizer` — `<span>`, class `dds-tab__sizer`. The width the label will need once it is current, held open while it is not.
+  
+  Selection steps the weight from 400 to 600, and a heavier word is a wider one — so the tab grew when it was pressed and every tab after it slid sideways. Product has the same step and the same jump; it only stops the weight from *animating*, which removes the smear and leaves the shift.
+  
+  So the label always contains its own bold copy, laid out and never drawn: the same words at the selected weight, in a block of zero height with its overflow clipped. The label is sized to the wider of the two, which is the bold one in both states, and nothing moves when the state changes.
+  
+  `aria-hidden`, and it has to be. This is the label's text a second time, and a screen reader reaching it would announce every tab twice. That is also why it is an element rather than a `::after` carrying `content: attr(...)` — generated content counts toward the accessible name in the browsers that implement the spec, and there is no way to hide a pseudo-element from assistive technology.
+  
+  `visibility: hidden` rather than transparent ink: it keeps the box out of the paint and out of what a pointer can select, so the words cannot be dragged over or copied twice.
+- `trailing-icon` — `<span>`, class `dds-tab__trailing-icon`. The trailing glyph, when the slot is carrying one. A box of the tab's own, unlike the badge: Icon takes the colour of the text around it and this part is what that colour is, so it steps from fg.muted to fg.default with the label.
+  
+  The badge gets no such box, and that is the same call Product's Tab makes — a Badge paints itself, so wrapping it would add a part with nothing to bind. Rendered only when `content` is set.
+
+Apply these classes from the generated `tabParts` constant rather than writing the strings by hand.
+
+## Composition
+
+- Takes no children. Everything it renders comes from props
+- Never contains: `Tab`, `TabList`, `Button`, `CardButton`, `Accordion`, `AccordionItem` — in children or in any prop that takes a node
+
+## Props
+
+### selected — `boolean`
+
+Use when: Injected by TabList, which is the only thing that can know. A tab cannot see its siblings, so a set of tabs each deciding for itself would show every one of them selected — the same reason Accordion holds which row is open. Passing it directly is how a strip says which tab it opens on
+Never for: Marking the tab a page prefers. Selected means the reader is looking at this one; the badge slot is what argues for a tab that is not current
+
+### onSelect — `callback`
+
+Use when: Learning which tab was pressed, when the page wants to know as well as the strip. TabList calls it after its own handler, so a page's handler is not replaced by being inside a set
+Never for: Driving the selection. The strip owns which tab is current; a page that sets it from here is racing the component for the same piece of state
+
+### value — `string` **Required.**
+
+Use when: Always — it is how the page says which slice to show. It is what reaches onSelect and what TabList compares its own value against, so it is required rather than defaulted: a tab identified by its position would renumber every time the set changes
+Never for: The label. A value is an identifier a page matches on and a label is words a reader reads; tying them means an editor cannot fix a typo without breaking the page
+
+### label — `string` **Required.**
+
+Use when: Always — it is what the reader presses. One or two words, and a noun rather than an instruction: 'Yearly', not 'Switch to yearly'. A string rather than a node, for the reason CardBody's title is one — a node prop cannot be given text in an examples row
+Never for: A sentence. The strip is scanned across, and a tab as wide as a clause is a strip that wraps
+
+### icon — `node`
+
+Accepts: QuillSystemIcon
+Use when: The tabs are things a mark tells apart faster than a word does — a platform, a market class. Pass the glyph; the tab draws it at its own step.
+
+Solid when the tab is current and regular otherwise, which is the package's `icon-solid-marks-selection` rule. Nothing here can enforce it: a Quill glyph's weight is chosen at the import, so a page that wants the swap passes a different glyph per state
+Never for: Carrying the label. A tab whose meaning is a shape is a tab a screen reader reads as nothing, and the words are what the strip is scanned by
+
+### badge — `node` **Required when content=badge.**
+
+Accepts: Badge
+Use when: A count or a claim for the version this tab names, shown when content is badge. One of the set is the one the page wants chosen and the reason fits in a word — 'Save 20%' on the yearly tab. On that tab and no other: a badge on every tab marks none of them
+Never for: Describing what the tab contains. A badge here argues for pressing this tab; one that merely labels its contents is metadata in a pill, and it competes with the selected mark for the same glance.
+
+The current tab, usually. It is already the marked one, and a second mark says the page is still asking for something the reader has already done
+
+### content — `none` | `icon` | `badge` (default `none`)
+
+- `none` — Nothing after the label. Most tabs, and the one to reach for unless something earns the space
+- `icon` — A glyph after the label, qualifying the view rather than naming it — that this one leads off-site, or that it is the one to look at. What names the view goes in the leading slot instead
+- `badge` — One of the set is the one the page wants chosen and the reason fits in a word — 'Save 20%' on the yearly tab. On that tab and no other: a badge on every tab marks none of them
+
+Use when: What the trailing side of the tab is carrying, when it is carrying anything. Product's Tab reads the same prop for the same reason, and the reason is the point: the slot holds one thing, and which one is a decision the page states rather than something inferred from which node was passed
+Never for: Two marks after one label. That is what naming the kind prevents — a trailingIcon left behind on a tab switched to badge renders nothing, instead of quietly appearing beside it
+
+### trailingIcon — `node` **Required when content=icon.**
+
+Accepts: QuillSystemIcon
+Use when: The glyph shown after the label when content is icon. Wrapped by the tab on the same ramp as the leading slot, so a strip carrying both draws them alike.
+
+Regular at rest and solid when current, the same rule the leading glyph follows and the same reason nothing can enforce it
+Never for: Naming the view. What the tab is goes before the words, where a reader looking for it will be — the trailing side qualifies what the label already said
+
+Also accepts everything from `ButtonHTMLAttributes<HTMLButtonElement>`.
+
+## 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: `button`
+- `Tab` — Reaches the tab. A strip is a group of buttons rather than a composite widget, so every tab is an ordinary stop and there is no roving tabindex to learn
+- `Enter` — Presses it
+- `Space` — Presses it, which is what a button does and an anchor would not
+- accessible name from label, because the glyph beside it is decorative and a badge on it argues rather than names
+- aria-current when selected, so a reader who cannot see the mark under it is told which version they are looking at rather than only shown
+- The current tab is set apart three ways over. Its label takes fg.default where the others take fg.muted, it steps from font.body.md's weight to font.label.md's — 400 to 600, where Product steps 400 to 500 because its type set has a medium and this one does not — and it announces aria-current. The bar beneath it belongs to the strip rather than to the tab. So the selection reaches a reader who cannot separate the two greys, one reading a printout, and one who cannot see the strip at all.
+
+## 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
+
+❌ Tab for: Pressing it should take the reader to another page
+   A tab that navigates is a link wearing a selected state. Button is the anchor this package has, and it announces a link rather than a control that changes something in place
+   → use `Button` instead.
+
+❌ Tab for: The item is one of a list of separate topics rather than a version of one
+   A tab says these are the same thing seen differently, so a reader expects to compare them. A row of unrelated topics under a tab strip tells them a comparison exists that does not
+   → use `AccordionItem` instead.
+
+❌ content=icon + trailingIcon missing or empty
+   content is icon and there is no glyph to show, which renders a gap where one was promised.
+
+❌ content=badge + badge missing or empty
+   content is badge and there is no badge to show, which renders a gap where one was promised.
+
+## Example
+
+```tsx
+import { Tab } from '@deriv-com/dds-marketing'
+
+<Tab value="yearly" label="Yearly" selected />
+```
+
+## In use
+
+### Current, and not
+
+The mark beneath it and the ink above it, both. A tab told apart by colour alone is one a reader who cannot separate two greys has to guess at.
+
+```tsx
+import { Tab } from '@deriv-com/dds-marketing'
+
+// Current
+<Tab value="yearly" label="Yearly" selected />
+
+// Not current
+<Tab value="monthly" label="Monthly" />
+```
+
+### A glyph, and the selected weight
+
+Solid when current, regular otherwise — the package rule, and the call site’s to obey. A Quill glyph’s weight is fixed at the import, so nothing here can check it.
+
+```tsx
+import { Tab } from '@deriv-com/dds-marketing'
+import { ChartCandlestickRegularIcon, GlobeSolidIcon } from '@deriv-com/quill-icons-web'
+
+// Current — solid
+<Tab value="web" label="Web" selected icon={<GlobeSolidIcon />} />
+
+// Not current — regular
+<Tab value="markets" label="Markets" icon={<ChartCandlestickRegularIcon />} />
+```
+
+### One or two words
+
+A strip is scanned across rather than down. A tab as wide as a clause is a strip that wraps, and a set nobody can compare at a glance.
+
+```tsx
+import { Tab } from '@deriv-com/dds-marketing'
+
+// One word
+<Tab value="web" label="Web" />
+
+// Two
+<Tab value="yearly" label="Billed yearly" />
+```
+
+### The trailing slot
+
+One mark at most, after the name. `content` names which kind it is, so a node left behind after a switch renders nothing rather than doubling the mark.
+
+```tsx
+import { Badge, Tab } from '@deriv-com/dds-marketing'
+import { ArrowUpRightRegularIcon } from '@deriv-com/quill-icons-web'
+
+// A badge — arguing for the tab that is not current
+<Tab value="yearly" label="Yearly" content="badge" badge={<Badge label="Save 20%" />} />
+
+// A glyph — this view leads off-site
+<Tab value="docs" label="Docs" content="icon" trailingIcon={<ArrowUpRightRegularIcon />} />
+
+// Nothing — most tabs
+<Tab value="monthly" label="Monthly" />
+```