@deriv-com/dds-marketing 0.1.0 → 0.2.0

package/.llm/components/removablechip.md

@@ -0,0 +1,247 @@
+<!-- GENERATED from removable-chip.contract.json. Do not edit. -->
+
+# RemovableChip
+
+A token standing for one thing that is already in play — a topic the reader has filtered by, a tag on an article, a market they have picked out — which they can take back out. It shows a set as it stands, and the only thing it does is go. Reach for one where a marketing page keeps a visible record of what the reader has narrowed to, and each piece of it has to be droppable on its own.
+
+## Use when
+
+- An index shows the narrowings currently applied above its results, and each has to come off on its own without clearing the rest
+- The reader has assembled something across a page — markets on a comparison, topics on a subscription form — and needs to see and unpick what is in it
+- What was chosen is worth showing as a token rather than as a sentence, because the reader will act on individual pieces of it
+
+## Do not use
+
+- The token is turned on and off rather than added and taken away → `FilterChip`
+- The thing named cannot be taken away and is there to be read — a category on a card, a status on a plan → `Badge`
+- The token is really a link to the thing it names → `Link`
+- Something the reader cannot get back. The cross is a small target beside the words and it is pressed by accident, so what a chip removes should be recoverable from whatever added it
+- An action other than removal. There is one control here and its meaning is fixed; a cross that archived or edited would be the same glyph meaning something else
+- A sentence. Chips are read as a set at a glance, and one carrying a phrase makes the row unreadable and pushes the rest out of view
+
+## Anatomy
+
+RemovableChip renders 5 elements. A token binding names the part it applies to.
+
+- `root` — `<span>`, class `dds-removablechip`. The chip, and deliberately not a control. The only thing to press here is the cross, so making the token itself pressable would give the reader two targets for one act and put a button inside a button — which this package forbids across Button, Link and TextInput, because nested controls are one ambiguous hit target with an inner half no keyboard can reach. The words are words; the cross is the control. It carries a painted ground rather than an outline, which is what says the thing is already in play rather than on offer, and it takes that ground at the same height and corner a FilterChip takes so the two stand level in one row. Its two ends take different insets: the leading one gives the words room, and the trailing one is set to what the height leaves around the remove target, so the target sits the same distance from the edge on every side of it rather than pushed off the cap.
+- `icon` — `<span>`, class `dds-removablechip__icon`. A glyph before the words — a topic, a market, a category. Its own part because a glyph arrives as somebody else's element and needs a box of its own to sit in. The box centres what it holds on both axes: a bare svg is inline, and left to the baseline it sits on the line the words sit on, riding high in a box whose height was set for it. Its colour comes from the words beside it. Rendered only when `leadingIcon` is set.
+- `label` — `<span>`, class `dds-removablechip__label`. What the token stands for. It truncates rather than wrapping, because a chip is one line in a row of them and one that grew two lines tall would push every sibling out of alignment — and a name cut short with the cross still reachable is better than a row that reflows as tokens arrive.
+- `remove` — `<button>`, class `dds-removablechip__remove`. The control that takes the token away, and the only control here. Always drawn: a token that cannot be removed is a label, and belongs as text or as a Badge rather than as a chip with its cross hidden. It carries its own accessible name so a reader hears what is going rather than a bare cross, and it declares a minimum of its own because a glyph is chosen for how it reads beside words rather than for how easily it is hit.
+- `remove-icon` — `<svg>`, class `dds-removablechip__remove-icon`. The cross itself, sized to read beside the words rather than to fill the target around it. Growing the mark to the target's measure would make a dismissal shout louder than the thing being dismissed, and the two sizes are separate decisions for that reason.
+
+Apply these classes from the generated `removableChipParts` constant rather than writing the strings by hand.
+
+## Composition
+
+- Takes no children. Everything it renders comes from props
+- Never contains: `Button`, `FilterChip`, `RemovableChip`, `Link`, `TextInput` — in children or in any prop that takes a node
+
+## Props
+
+### disabled — `boolean` (default `false`)
+
+Use when: The token cannot be removed just now — something else is in progress, or the narrowing is the last one and the index will not show nothing. It dims and takes the cross out of the tab order
+Never for: The reader could act on it if they knew what to change. This says the act is closed and nothing about why, so a reason belongs in the prose around the set
+
+### size — `sm` | `md` (default `sm`)
+
+- `sm` — The default, and the same measure a FilterChip takes at its own default, so a row holding both sits level
+- `md` — A touch-first layout, level with a FilterChip at its largest. The cross gains room around it rather than growing: it is already at the smallest a target may be
+
+Use when: How dense the row is, matched to whatever it sits beside. It takes the same control ramp a FilterChip does, so the two never sit at different heights in one row
+Never for: Marking one token in a set as more important. They are a set of equals and a row of mismatched heights reads as a mistake before it reads as emphasis
+
+### label — `string` **Required.**
+
+Use when: Always, and required on that account — it names the thing the token stands for. Short enough to read at a glance in a row of them
+Never for: Describing what the cross does. That is removeLabel, which a screen reader reads and nobody sees
+
+### leadingIcon — `node`
+
+Accepts: QuillSystemIcon
+Use when: A glyph makes the kind of thing recognisable before the words are read. It sits before the name and never replaces it. Pass the glyph itself rather than one already wrapped in an Icon: the token wraps it at icon.size.xs at sm and icon.size.sm at md.
+Never for: Decoration. A row where every token carries the same mark reads more slowly than the names alone would
+
+### onRemove — `callback` **Required.**
+
+Use when: Always, and required on that account: removal is the whole of what this component does, and a cross reporting to nobody is the clearest promise a chip can break — the reader presses it more than once before deciding the page is at fault
+Never for: Clearing the value while leaving the token. Removing a chip removes the thing; a cross that empties something and leaves its token behind tells the reader it is still there
+
+### removeLabel — `string` (default `Remove`)
+
+Use when: The accessible name of the cross, which announces nothing on its own. Override it to name what is going: a row of buttons all saying Remove leaves a reader who cannot see the tokens unable to tell which one they are about to lose
+Never for: Visible text. Nothing here renders it — the cross is the whole of what is drawn
+
+Also accepts everything from `HTMLAttributes<HTMLSpanElement>`.
+
+## 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 narrowings currently applied, above an index** — `leadingIcon={<Icon>…</Icon>}`
+  This is the one standing for a narrowing already applied, which the reader drops rather than turns off. Beside it a FilterChip toggles. Dropping and un-choosing are different acts, which is why they are different components even here, where they do the same job
+- **Topics a reader has picked on a subscription or preference form** — `leadingIcon={<Icon>…</Icon>}`
+  Each stands for something the reader added and can take away, and the glyph makes one recognisable before the words are read
+- **An item that cannot be removed while something else is in progress** — `disabled`
+  It stays in the set so the row does not reflow, and its cross leaves the tab order rather than offering the one act that is closed
+
+## 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` — One stop, onto the cross. The words are words and take no focus — a token whose whole surface were focusable would put a stop on every name in a row full of them
+- `Enter` — Removes the token
+- `Space` — The same as Enter, which a button answers by being one
+- the cross carries an accessible name from removeLabel, and the name says what goes. It is the only thing here with a role, so it is also the only thing a reader arrives at
+- the words are not a control. Making the token pressable would give one act two targets and nest a button inside a button, which is one ambiguous hit target with an inner half no keyboard can reach
+- a disabled token takes its cross out of the tab order rather than announcing it and refusing. There is nothing here to explain, so the native attribute is the honest one
+
+## 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
+
+❌ RemovableChip for: The token is turned on and off rather than added and taken away
+   Un-choosing a thing and removing it are different acts: one leaves the token on screen saying no, the other takes it away. A reader expecting a toggle and finding a cross loses the thing entirely, and there is no way back from a token that is gone
+   → use `FilterChip` instead.
+
+❌ RemovableChip for: The thing named cannot be taken away and is there to be read — a category on a card, a status on a plan
+   Readers learn that chips can be acted on, so one with nothing to act on is a control that is not one
+   → use `Badge` instead.
+
+❌ RemovableChip for: The token is really a link to the thing it names
+   A tag that goes somewhere is a place and should be an anchor. A chip carries a cross and promises removal; giving it a second job makes one token answer two different presses
+   → use `Link` instead.
+
+## Example
+
+```tsx
+import { RemovableChip } from '@deriv-com/dds-marketing'
+
+<RemovableChip onRemove={() => { /* your handler */ }} label="Market news" />
+```
+
+## In use
+
+### What is already applied
+
+A painted brand ground where a FilterChip at rest carries an outline — which says the thing is already in play rather than on offer. The cross is the only control.
+
+```tsx
+import { RemovableChip } from '@deriv-com/dds-marketing'
+import { ChartCandlestickRegularIcon } from '@deriv-com/quill-icons-web'
+
+// One narrowing, droppable on its own
+<RemovableChip onRemove={() => { /* your handler */ }} label="Market news" />
+
+// With a glyph naming the kind before the words are read
+<RemovableChip onRemove={() => { /* your handler */ }} label="Trading" leadingIcon={<ChartCandlestickRegularIcon />} />
+```
+
+### A set as it stands
+
+Each comes off on its own without clearing the rest. The cross names what goes — a row all announcing "Remove" leaves a reader unable to tell which they will lose.
+
+```tsx
+import { RemovableChip } from '@deriv-com/dds-marketing'
+
+// First of three applied
+<RemovableChip onRemove={() => { /* your handler */ }} label="Trading" removeLabel="Remove Trading" />
+
+// Second
+<RemovableChip onRemove={() => { /* your handler */ }} label="Market news" removeLabel="Remove Market news" />
+
+// Third
+<RemovableChip onRemove={() => { /* your handler */ }} label="Education" removeLabel="Remove Education" />
+```
+
+### Unavailable
+
+It stays in the set so the row does not reflow, and its cross leaves the tab order rather than offering the one act that is closed.
+
+```tsx
+import { RemovableChip } from '@deriv-com/dds-marketing'
+
+// The last narrowing — the index will not show nothing
+<RemovableChip onRemove={() => { /* your handler */ }} label="Trading" disabled />
+```
+
+### Sizes
+
+The same two steps a FilterChip takes, so a row holding both sits level. At md the cross gains room around it rather than growing.
+
+```tsx
+import { RemovableChip } from '@deriv-com/dds-marketing'
+
+// sm — the default
+<RemovableChip onRemove={() => { /* your handler */ }} label="Market news" size="sm" />
+
+// md — level with a FilterChip at its largest
+<RemovableChip onRemove={() => { /* your handler */ }} label="Market news" size="md" />
+```