@deriv-com/dds-marketing 0.1.0 → 0.2.0

package/.llm/components/divider.md

@@ -0,0 +1,230 @@
+<!-- GENERATED from divider.contract.json. Do not edit. -->
+
+# Divider
+
+A rule between things, and the quietest way to say that what is on one side of it belongs to a different group from what is on the other. One line, in the one ink this package keeps for a separator, with no room of its own — optionally with a word held in the middle of it, where the word is the whole message.
+
+## Use when
+
+- Two groups inside one container that nothing else is separating — a footer's link columns, the tiers inside a pricing card, a card's summary above its detail. Where a heading or a surface of its own already tells the groups apart, that is doing this component's job better than it can
+- A row of items holding one that belongs to a different set from its neighbours — the vertical case. A legal line beside a copyright notice, a language picker at the end of a nav. It takes its height from the row rather than declaring one, so it is as tall as whatever it stands between
+- A word between two rules, where that word is the entire content of the divide: OR between two ways of signing up, and little else. The rules either side are what make it read as a fork rather than as a heading
+
+## Do not use
+
+- The groups have names → `Typography`
+- The space between the groups already separates them → nothing here does this
+- The line wanted is the edge of a surface → `Card`
+- The line wanted is the rail under a tab strip → `TabList`
+- Room. It draws a line and owns no space around it, so the air either side is the layout's — only the thing holding the groups knows how much air they deserve. A rule that carried margins of its own would be a rule nobody could put anywhere, because every place it went would need them different
+- A line under every heading. A page ruled off at each of its headings reads as a form to be filled rather than as prose to be read, and the rules stop meaning anything once they are everywhere — which is the state a divider cannot recover from, since it has only one thing to say. A marketing page is especially exposed to this: it is mostly headings
+- Two rules with nothing between them, or a rule at the start or end of a set. A separator separates, so one with a group on only one side of it is a line drawn around nothing — and at the edge of a container it is the container's own border, moved inward by a pixel and drawn in the wrong ink
+- Structure a reader navigates by. A screen reader announces a separator where it helps and skips it where it does not; what makes a group findable is a heading or a list, and a rule is neither. If a group has to be reachable, give it something with a name
+- Carrying a status, a warning, or any other meaning through colour. There is one ink here and it is the quietest one this package has, deliberately: a red rule is a message nobody can read, and the message belongs in words on the surface the rule divides
+
+## Anatomy
+
+Divider renders 3 elements. A token binding names the part it applies to.
+
+- `root` — `<div>`, class `dds-divider`. The divider itself, and the whole of what it draws. A flex box rather than a single ruled element, because the labelled case has to split the line in two and put the word between the halves — and one shape that covers both is worth more than a bare rule that becomes a different component the moment it carries a word. It paints nothing itself: the line is a part, so the ink and the thickness are bound in one place and mean the same thing whether there is one line or two. It is a separator when there is no word in it, and it is not one when there is — a separator's children are presentational to a screen reader, so a label inside one is drawn and never announced, which is the opposite of what a word between two rules is for. Its own gap is what holds the word off the lines, declared unconditionally rather than only when a label arrives, because a flex box with one child has nothing to space: the value is there and costs nothing until there is a second line for it to separate. The horizontal case declares all of whatever contains it rather than waiting to be stretched by it, because the containers it lands in do not agree: a block parent and a flex column hand it a width, and a container that centres its contents — a grid cell, a specimen stage, a card that centres — sizes it to its content, which for a rule is nothing at all. Drawing nothing is this component's one unrecoverable failure, because there is no partial version of it to notice: a rule that is not there and a rule that was never asked for look identical. The vertical case cannot take the same declaration and does not: a height of all-of-its-container replaces the automatic cross-size that stretch depends on, so in the flex row this orientation exists for it would resolve against an indefinite height and collapse.
+- `line` — `<span>`, class `dds-divider__line`. The rule. One of these when the divider carries no word and two when it does, one either side, which is why this is a part rather than a border on the root — a border cannot be halved, and two of them would be two places to change the ink. Drawn as a filled box a border's width thick rather than as a border, because the property vocabulary holds no per-side border width: a border would have to be declared on all four edges and drawn on one, which is a rectangle asking to be mistaken for a rule. The thickness comes from border.width.default, because that is what a line between two things weighs everywhere else in this package, and a divider that disagreed with a card's edge would read as a different kind of boundary. It grows along whichever axis the root lays out, from a basis of zero rather than from its content, so the two halves of a labelled rule are equal however long the word is.
+- `label` — `<span>`, class `dds-divider__label`. The word in the middle, and ordinary content rather than a name on the divider: it is announced because it is text on the page, which is why the root gives up its separator role to hold it. Held to one line, because a word that wrapped would take the rules with it and leave two of them at different heights. It keeps its own width and the lines give way around it, which is the honest failure for a label too long: the rules shorten until they are gone rather than the word being cut, and a divider with no line left in it is visibly the wrong component for the sentence somebody put in it. Its ink is the quietest this package has and its type is the smallest label step, so the rule and the word read as one quiet mark rather than as a line with a heading in it. Rendered only when `label` is set.
+
+Apply these classes from the generated `dividerParts` constant rather than writing the strings by hand.
+
+## Composition
+
+- Takes no children. Everything it renders comes from props
+- Never contains: `Divider`, `Button`, `ButtonIcon`, `TextInput`, `Card`, `Icon`, `Badge` — in children or in any prop that takes a node
+
+## Props
+
+### orientation — `horizontal` | `vertical` (default `horizontal`)
+
+- `horizontal` — The default, and nearly every divider: a rule across a stack, separating what is above it from what is below. It takes all of whatever contains it rather than waiting to be stretched, so it spans a block, a flex column and a centred grid cell alike — and in a flex row, where it has no business being, it takes the row's whole width rather than a share of it, which is the sign that the rule wanted the other axis
+- `vertical` — A rule down a row, separating items beside one another. It stretches to the height of the row rather than declaring one, so it is exactly as tall as what it stands between — and in a container with no height of its own it draws nothing, which is the mirror of the horizontal case and the same thing to check first
+
+Use when: The axis the groups are arranged on. A rule across a stack is horizontal; a rule down a row is vertical
+Never for: Turning a rule to fit a layout that has not decided what it is. The orientation follows the axis the groups are arranged on — a vertical rule between two stacked groups says they sit side by side, which is a claim about the layout that the layout will contradict. Nor a vertical rule with a label: the rules run above and below the word, so it sits in a column as wide as a line is thick and either overflows the row or wraps to a letter per line. That pairing is stated here and in the label's own guidance rather than in illegalCombinations, which holds one rule per case and spends its one on the failure nobody can see — a label hidden from a screen reader looks right on the screen, where a word in a vertical rule is wrong in the first render
+
+### label — `string`
+
+Use when: The divide has a word, and the word is short: OR between two ways of signing up, and very little else. Passing one takes the separator role off the divider and makes the word ordinary text, which is what makes it announced — so this is the only way a divider says anything out loud
+Never for: A sentence, or a heading. The word sits between two rules in the width of a container, so anything longer takes the rules with it: at a phrase there is little line left on either side, and at a sentence the divider has become a caption drawn in the wrong ink. If it needs to be read as a heading, it is one — and a heading has a rule under it only if somebody decided it should. Nor anything pressable: a divider holds no role that a control could live inside, and a focus stop in a rule is a focus stop nobody can explain. Nor a vertical divider, whose rules run above and below the word rather than either side of it — a word there is a column one line thick, and it wraps to a letter per line or pushes the row apart
+
+### decorative — `boolean` (default `false`)
+
+Use when: The grouping this rule draws is already announced some other way — the rows either side are list items, the sections either side have headings of their own. The line is then the sighted reader's copy of something a screen reader already has, and a separator announced on top of it is the same fact twice
+Never for: A rule that is the only thing saying the groups are different. That is the ordinary case, which is why it is the default: where the line carries the grouping for the reader who can see it, the separator role is what carries the same grouping for the reader who cannot, and hiding it takes the structure away from exactly one audience
+
+## 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.
+
+- **Between the link columns and the legal line in a footer** — `orientation="horizontal"`
+  A footer is the densest part of a marketing page and the one place its air has run out. The rule says the small print below is a different group from the navigation above it, which nothing else on that surface is saying
+- **OR between two ways of signing up** — `label="OR"`
+  The word is the whole of the divide, and the rules either side are what make it read as a fork rather than as a heading. Passing a label takes the separator role off, which is what makes the word announced rather than drawn and silently skipped
+- **Beside a language picker at the end of a nav row** — `orientation="vertical"`
+  It stretches to the height of the row rather than declaring one, so it is exactly as tall as what it stands between
+
+## 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: `separator`
+- role="separator" while there is no label, which is what tells a screen reader that the groups either side of it are different groups. A div rather than an <hr> because the labelled case cannot be one, and a component that changed element as well as role would be two components wearing one name
+- aria-orientation="vertical" while orientation is vertical, and the attribute absent otherwise. A separator is horizontal by default, so the attribute is written only where it says something — and where it is missing on a vertical rule, a reader is told the groups are stacked when they sit side by side
+- no separator role at all while a label is given, and no aria-orientation with it. A non-focusable separator's children are presentational, so a word inside one is drawn and never announced — the role would silence the only thing here that was meant to be read. Without it the word is ordinary text and the lines either side are decoration, which is what they are
+- out of the accessibility tree entirely while decorative, rather than dimmed or renamed. A rule whose grouping is already announced by the headings or the list items either side of it has nothing left to add, and a separator announced on top of that structure is noise a reader cannot turn off
+- no focus and no keyboard behaviour, in any combination. A divider is not a control and holds none: there is nothing here to reach, nothing to operate, and no tab stop to explain — which is also why nothing pressable may be put in the label
+- the rule is never the only thing carrying a difference that matters. It is drawn in the quietest ink this package has, below the contrast a reader with low vision can rely on, and that is deliberate for a boundary — so wherever the difference between the two groups changes what a reader should do, it is also said in words on the surface itself
+
+## 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
+
+❌ Divider for: The groups have names
+   A heading says what the next group is; a rule only says that it is a different one. Where there is something to call the group, calling it is worth more than ruling it off — and a heading with a line under it as well states the boundary twice, once in words and once in a way that cannot be read
+   → use `Typography` instead.
+
+❌ Divider for: The space between the groups already separates them
+   Space is the cheaper separator and the one to reach for first, and a marketing page has more of it to spend than an app view does: a section with a generous band of air around it needs no line, and a line drawn across enough space is decoration. What earns a rule is space that is not available — a card whose padding is already spent, a dense footer, a row of links
+   → nothing in this system does this. Not a gap waiting to be filled — the case belongs outside it.
+
+❌ Divider for: The line wanted is the edge of a surface
+   A container draws its own edge, and a rule laid along it is a second line in the same place at a different alpha — which reads as one thick, uneven border rather than as two decisions
+   → use `Card` instead.
+
+❌ Divider for: The line wanted is the rail under a tab strip
+   TabList draws that rail as its own border with the indicator riding on it, so a divider placed under a strip is a second rail the indicator cannot reach — and the two sit a pixel apart at different weights
+   → use `TabList` instead.
+
+❌ decorative=true + label is set
+   A labelled divider is not a separator — the word is content, and content is why the role is given up. Hiding it removes the one thing here that was ever going to be read, and leaves a rule that says nothing to anybody who cannot see it.
+
+## Example
+
+```tsx
+import { Divider } from '@deriv-com/dds-marketing'
+
+<Divider label="OR" />
+```
+
+## In use
+
+### A rule, and a rule with a word in it
+
+The bare case says only that the groups differ. The labelled case says what the divide is — and passing a word is what makes it announced rather than drawn and skipped.
+
+```tsx
+import { Divider } from '@deriv-com/dds-marketing'
+
+// Bare — the ordinary case
+<Divider />
+
+// A word, where the word is the whole message
+<Divider label="OR" />
+```
+
+### Down a row instead of across a stack
+
+It stretches to the height of the row rather than declaring one, so it is exactly as tall as what it stands between. In a container with no height of its own it draws nothing.
+
+```tsx
+import { Divider } from '@deriv-com/dds-marketing'
+
+// vertical — between items beside one another
+<Divider orientation="vertical" />
+```
+
+### When the grouping is already announced
+
+The rows either side are list items, or the sections have headings of their own. The line is then the sighted reader's copy of something a screen reader already has.
+
+```tsx
+import { Divider } from '@deriv-com/dds-marketing'
+
+// decorative — drawn, and out of the tree
+<Divider decorative />
+```
+
+### A word too long for the divide
+
+The rules shorten until they are gone rather than the word being cut — which is the honest failure, because a divider with no line left in it is visibly the wrong component for the sentence in it.
+
+```tsx
+import { Divider } from '@deriv-com/dds-marketing'
+
+// Short enough — the rules still read
+<Divider label="OR" />
+
+// A phrase, and little line left either side
+<Divider label="or sign up with email instead" />
+```