@deriv-com/dds-marketing 0.1.0 → 0.2.0

package/.llm/components/footergroup.md

@@ -0,0 +1,241 @@
+<!-- GENERATED from footer-group.contract.json. Do not edit. -->
+
+# FooterGroup
+
+A named handful of destinations in the footer: a word over a short list. It is the footer's repeating unit and the only thing inside it that repeats — everything else in a footer appears once.
+
+It is not a column. A footer's columns hold two or three of these stacked, and which group lands in which column is the footer's business rather than the group's: Trade, Markets and Payments share one, Platforms, Promotions and Tools share the next. A group that assumed it was a column would be a group that could not be put beside another.
+
+On a narrow page it collapses. The label becomes the control that opens it, which is the whole reason this is a component and not a heading with a list under it — eleven groups open at once is a page of links nobody scrolls past, and the same eleven closed is a menu a reader chooses from. Wide enough and the list is simply open, with nothing to press.
+
+## Use when
+
+- A set of a footer's destinations belong under one word — Markets, Support, Legal
+- The footer has enough links that a reader scanning it needs sets rather than a list
+
+## Do not use
+
+- The destinations are the ones a visitor most likely wants → `Navbar`
+- The group is a named set inside a navigation panel → `NavbarMenuGroup`
+- There is one link rather than a set → `Link`
+- A heading over prose. The list holds destinations; a paragraph in it is a paragraph a screen reader announces as a list item
+- Nesting. A group inside a group is a second disclosure, and a reader who has opened one thing to find another has been given a menu rather than a footer
+- A set long enough to need scrolling. Eleven destinations under one word is a group that should be two
+
+## Anatomy
+
+FooterGroup renders 6 elements. A token binding names the part it applies to.
+
+- `root` — `<div>`, class `dds-footergroup`. The group: a word and the set under it.
+  
+  A column, so the list sits beneath the label at every width. What changes with the width is whether the list is there at all, never where it is.
+- `heading` — `<div>`, class `dds-footergroup__heading`. The word over the list, once there is no longer anything to open.
+  
+  A second element carrying the same string as the trigger's label, and that is the point rather than an oversight. The label cannot live inside the trigger alone, because above the footer's width the trigger is not drawn and the word would go with it — which is exactly what happened the first time this was built. Nor can one element be a button at one width and a div at another: React would remount it, and the markup would have two shapes.
+  
+  So both exist always and the stylesheet picks one. `display: none` takes the other out of the accessibility tree as well as the layout, so a screen reader is never offered the word twice.
+  
+  A <div> and not a heading, which is what NavbarMenuGroup settled on for the same object: a footer of six sets would put six headings into the document outline, and a reader moving by heading would find the end of the page is most of its structure.
+  
+  It is also the list's accessible name at both widths — named through `aria-labelledby`, which reads a hidden element perfectly well, so the name does not change when the layout does.
+  
+  Quieter than what it names — `color.fg.muted-inverse` against the destinations' inherited ink — because it is a signpost rather than a destination, which is the relationship NavbarMenuGroup draws with `color.fg.muted` on a light page. That role could not be borrowed: it is defined against white and comes to 3.56:1 on this band, which is a label a reader with low vision is asked to take on trust.
+  
+  The inverse role is white at half rather than a grey of its own, which is how every other `-inverse` role in this package is built. A veil takes the hue of the band under it, so the labels stay in the footer's own colour instead of reading cool against a warm ground — and a fixed grey is only muted against the one band it was picked for.
+  
+  This one keeps an inverse ink where the trigger does not, and the difference is that it cannot be drawn anywhere else. It carries `display: none` by default and the only rule that reveals it is inside the container query, which only the band declares a container for — so a heading that is visible is a heading on the band, and `color.fg.muted-inverse` is not an assumption there but a fact. The step down from the band's own ink is deliberate: a signpost over a column is quieter than the destinations under it.
+- `trigger` — `<button>`, class `dds-footergroup__trigger`. The word, and on a narrow page the control that opens the set.
+  
+  A <button>, drawn only while there is something to open — above the footer's own width it is not drawn at all and the `heading` beside it carries the word instead — the arrangement Navbar uses for the control it keeps only while collapsed. The element never changes, so React never remounts it; the list is simply open on a wide page; and there is no control left for `aria-expanded` to describe, so the attribute cannot end up disagreeing with what a reader is looking at.
+  
+  A button that stayed and did nothing would be worse than it sounds: a tab stop before every set of links, announced as collapsible, toggling a state the stylesheet overrules.
+  
+  It carries the whole width of the group so the chevron sits at the far end of the label's line rather than against the word. A target the width of the column is also the target a thumb actually gets, which is the case this collapses for.
+  
+  It takes `space.gap.sm` in the block axis, which is the row a thumb meets. Sixteen was the first answer and was too much: with the grid's own step between one set and the next, two collapsed rows sat fifty-six pixels apart word to word, which is a list of eight sets that no longer reads as a list.
+  
+  There is no hover treatment, and that is a decision rather than a gap. This control is only drawn below the footer's own fold, which is very nearly the definition of a touch screen — and a touch screen reports a hover that never ends, so the last set tapped would keep its wash until something else was tapped. A veil that is wrong wherever the control actually appears is a veil worth not having. Focus is untouched: a keyboard still needs to be told where it is.
+  
+  It sets its own colour, which a button has to. A `<button>` does not inherit `color` — the user agent gives it `buttontext` — so the chevron inside took near-black on a near-black band and drew nothing at all. The label carries its own ink for its own reason; this is what the mark reads.
+  
+  Its ink is `inherit` rather than the band's, and it is set at all only because a `<button>` does not take one: the user agent gives it `color: buttontext`, so the word and the chevron inside it drew near-black on a near-black band until something said otherwise. `inherit` is what that something should be. The band paints the ground and sets the ink once on its own root — the package's rule about a section that paints a ground — and every other thing in the footer takes it from there; a group that named the same colour a second time was agreeing with the band by coincidence rather than by construction, and disagreeing with any other ground. Off the band it was the same failure the other way round: white on the documentation page's white, a component that rendered nothing at all.
+- `label` — `<span>`, class `dds-footergroup__label`. The word the set is under.
+  
+  Set in `font.label.md`, which is what NavbarMenuGroup gives its own — the two are the same object in two places, and a footer whose group labels were a different step from a panel's would be the same site disagreeing with itself.
+  
+  In the band's full ink, where the `heading` beside it is muted. The two carry the same string and are not the same job: the heading is a signpost over a list a reader can already see, so it should be quieter than the destinations it names. This is the row — on a narrow page it is the whole of a shut set and the thing a thumb lands on, and a footer of eight collapsed sets in muted grey is a screen with nothing on it at full strength.
+  
+  It binds no colour. It is inside the trigger, the trigger inherits, and a second statement of the same ink is a second place for it to drift.
+- `marker` — `<svg>`, class `dds-footergroup__marker`. The chevron that says the set opens, and which way.
+  
+  The part is the glyph rather than a box around it, which is how DropdownMenu carries its own. A box takes the size bindings and the glyph inside it keeps whatever it arrived with — so `inline-size` sized a span, `flex: none` held the span at sixteen pixels, and the mark within it collapsed and drew nothing at all.
+  
+  Drawn only where there is something to open, which it gets for free: it sits inside the trigger, and above the footer's own width the trigger is not drawn.
+  
+  The angle is written inline, a rotation being no token's business, and the transition is bound per direction so the generated reduced-motion block covers both.
+- `list` — `<ul>`, class `dds-footergroup__list`. The destinations, one per row.
+  
+  A <ul>, because it is a list and a screen reader counting it out is the point — 'Markets, list of seven items' is the thing a reader scanning a footer wants to hear before they decide to listen to all seven.
+  
+  Gone from the layout when the set is shut, rather than merely invisible: a link a pointer cannot see but a keyboard still reaches is worse than one nobody can reach at all.
+  
+  The links inside it are given Link's `list` variant by this component rather than by the page. A standalone link — the default — is coral and carries a trailing arrow, which is right for one alone on its line and wrong for every row of a sitemap: a column of coral is a column nobody reads, and an arrow on every row distinguishes none of them. The `list` variant holds that mark at zero and lets the pointer bring it in, takes the ink of the ground, and leaves an external link's own mark alone, which is what lets one row say it leaves the site.
+  
+  Injected rather than documented, which is the correction. Saying it in guidance meant a page that forgot got a column of coral arrows and no gate anywhere said so — the preview's own generated children did exactly that. Select injects into its Options on the same reasoning: the parent owns what it arranges.
+  
+  The rows take `space.gap.md` and the label sits `space.gap.lg` above them, with the grid's own `space.gap.xl` between one group and the next: sixteen, twenty-four, thirty-two. Three steps narrowing inwards is what makes a set read as a set — the space inside has to be smaller than the space around it, or two columns become one list of alternating words.
+  
+  One step wider than NavbarMenuGroup's eight and sixteen, and the whole ladder moved rather than the rows alone. A footer is read at arm's length down a column of twenty destinations where a panel is read in a glance, so the rows want the air; opening them on their own would have put the same distance between a label and its first destination as between two destinations, and the label would have become one more row.
+  
+  This part carried a `padding-block-start` as well for a while, on top of the root's gap. The two added up to twenty-four — the same distance the grid puts between one group and the next — and a label as far from its own first destination as from the next group is a label that has come loose from what it names.
+
+Apply these classes from the generated `footerGroupParts` constant rather than writing the strings by hand.
+
+## Composition
+
+- Can contain: `Link`
+- Never contains: `FooterGroup`, `Footer`, `Button`, `Card`, `Accordion` — in children or in any prop that takes a node
+
+## Props
+
+### expanded — `boolean` (default `false`)
+
+Use when: Whether the set is open, on a page narrow enough for it to close. Left alone the group holds this itself, which is what a footer of eleven groups wants — the page has no reason to know which ones a reader has opened
+Never for: Forcing a group open on a wide page. There is nothing to force: above the footer's own breakpoint every list is open and this value is not read
+
+### label — `string` **Required.**
+
+Use when: Always — it is the word the set is under, and the control that opens it on a narrow page. One or two words naming a kind: 'Markets', 'Partner with us'
+Never for: A sentence, or a destination. The label names the set and goes nowhere; a reader who presses it on a phone expects the set, and on a wide page it is not pressable at all
+
+### onExpandedChange — `callback`
+
+Use when: Told when a set opens or shuts, for a page that drives them from outside — one open at a time, or a set opened by a link somebody followed
+
+Also accepts everything from `HTMLAttributes<HTMLDivElement>`.
+
+## 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.
+
+- `Enter` — open or shut the set, on a page narrow enough for it to close
+- `Space` — the same as Enter, the trigger being a button and inheriting both
+- The trigger carries `aria-expanded`, and above the footer's own width it is not drawn at all — so there is never a control announced as collapsible that cannot be collapsed. Hiding the control rather than dropping the attribute is what keeps the two from disagreeing: a container query decides the width and JavaScript cannot read one, so an attribute computed here would be a guess about a layout it cannot see.
+- The trigger points at the list through `aria-controls`, so a reader told a set has opened can be taken to what opened.
+- The chevron is decorative. `aria-expanded` says which way it points, and says it to a reader who cannot see a chevron at all.
+- The list is named by the heading through `aria-labelledby`, at both widths. A hidden element is still read for a name, so the list keeps the same one whether the word is being drawn by the heading or by the trigger — and a list of destinations announced as nothing is a set a screen reader cannot offer.
+
+## 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
+
+❌ FooterGroup for: The destinations are the ones a visitor most likely wants
+   A footer is where a reader looks after not finding it above. What belongs in the top bar belongs in the top bar
+   → use `Navbar` instead.
+
+❌ FooterGroup for: The group is a named set inside a navigation panel
+   The same shape for a different place, and it never collapses — a panel is already a disclosure, so a second one inside it is two presses to reach a link
+   → use `NavbarMenuGroup` instead.
+
+❌ FooterGroup for: There is one link rather than a set
+   A label over a list of one is a word doing nothing. Put it in a neighbouring group or leave it in the footer's own row
+   → use `Link` instead.
+
+## Example
+
+```tsx
+import { FooterGroup, Link } from '@deriv-com/dds-marketing'
+
+<FooterGroup label="Markets">
+  <Link href="/markets/forex">Forex</Link>
+  <Link href="/markets/stocks">Stocks</Link>
+  <Link href="/markets/crypto">Cryptocurrencies</Link>
+</FooterGroup>
+```
+
+## In use
+
+### Open, and shut
+
+On a narrow page the label is the control that opens the set. Wide enough and the trigger is not drawn at all — the list is simply open, and there is no control left to announce.
+
+```tsx
+import { FooterGroup, Link } from '@deriv-com/dds-marketing'
+
+// Shut — the state a phone opens on
+<FooterGroup label="Markets" expanded={false}>
+  <Link href="/markets/forex">Forex</Link>
+  <Link href="/markets/stocks">Stocks</Link>
+</FooterGroup>
+
+// Open — and how every set looks on a laptop
+<FooterGroup label="Markets" expanded>
+  <Link href="/markets/forex">Forex</Link>
+  <Link href="/markets/stocks">Stocks</Link>
+</FooterGroup>
+```