@deriv-com/dds-marketing 0.1.0 → 0.2.0

package/.llm/components/searchinput.md

@@ -0,0 +1,279 @@
+<!-- GENERATED from search-input.contract.json. Do not edit. -->
+
+# SearchInput
+
+A query a visitor types to find something the page did not put in front of them — a help centre, a blog or docs index, a directory of markets. It reports the query and nothing else: what gets searched, how, and what an empty result says all belong to the page, because a field that decided any of that would be wrong for the next list.
+
+It is its own component rather than a TextInput with a magnifier in it, and the two things that make it one are the gesture and the escape. A search commits — on Enter, or as each keystroke filters — where a field in a form waits for a submit button that belongs to the form. And Escape clears it, which no other field here does, because a query is a thing a reader abandons rather than corrects.
+
+A marketing page reaches for it when the content outgrew its navigation. A site with six pages has no use for one, and putting a search on it tells a reader there is more here than they can see, which is either untrue or an admission about the navigation.
+
+## Use when
+
+- A help centre, a knowledge base, or documentation — more pages than a menu can carry
+- A blog or resource index a reader arrives at knowing roughly what they want
+- A directory the page already holds and can filter as the reader types — markets, offices, partners
+
+## Do not use
+
+- The field is part of a form the reader will submit → nothing here does this
+- The set is small enough to show at once → nothing here does this
+- The reader is choosing from known options rather than describing what they want → nothing here does this
+- Navigation a menu should carry. A search is where a reader goes when the menu failed them, not a substitute for writing one
+- A page with nothing to search. An empty index behind a search box is a dead end the reader reached by doing what the page asked
+
+## Anatomy
+
+SearchInput renders 7 elements. A token binding names the part it applies to.
+
+- `root` — `<div>`, class `dds-searchinput`. Stacks the label, the field and its helper text. Carries the size attribute, which is what lets every part below respond to it — and only that one, because nothing here reports a status: a search field has nothing to judge.
+- `label` — `<label>`, class `dds-searchinput__label`. Names the field, and stays in the accessible tree whether or not it is drawn. Clipped by default rather than shown, because a search field in a toolbar conventionally carries a magnifier and a placeholder and no label at all — which is why the magnifier is rendered unconditionally rather than offered as a slot. The two decisions are one: the mark is the visible cue when the label is not.
+- `control` — `<div>`, class `dds-searchinput__control`. The box the user sees: the border, the fill, the corner and the height. Separate from the field because an <input> cannot contain anything, so nothing could ever sit inside the box while the input was drawing it. A row, so what sits beside the input sits beside it rather than under it.
+- `search-icon` — `<span>`, class `dds-searchinput__search-icon`. The magnifier, before the query. Rendered by the component rather than passed in, and unconditionally: with the label clipped by default this is the only thing on screen saying what the field is for, so a slot could empty it and a different glyph could contradict it. Decorative to a screen reader, which has the label and the role.
+- `field` — `<input>`, class `dds-searchinput__field`. The field itself, of type search — which is what makes the component a searchbox rather than a textbox, and the reason this is not TextInput with a magnifier in its slot. The browser draws its own clear control inside a search field, suppressed in the implementation stylesheet because a keyword on a pseudo-element is the one thing a contract cannot say.
+  
+  Its padding is reset, which is not tidiness. A form control arrives with one from the browser — two pixels either side of the text in Chrome, and one above and below — and the box around it is what carries the inset here, so the browser's two pixels land on top of the measure the token names. The text then starts two pixels further in than anything else lined up against that edge, and nothing in the contract says why.
+- `clear` — `<button>`, class `dds-searchinput__clear`. Empties the query, and follows the query rather than a prop: it is there whenever there is something to empty and gone when there is not. Not offered as a choice, because a search field that cannot be cleared in one press is a search field nobody clears — which is why there is no `clearable` here and TextInput has one. Escape does the same from the keyboard, right for a query and alarming on a field holding somebody’s name. Withdrawn while the field is disabled: a live control on a field the reader cannot use is worse than no control. The `defaultValue` named below is one way to have a query, not the only one — a typed query does the same.
+  
+  It paints a background on hover, which is the only thing that shows where the target is. The mark is sixteen pixels and the target is twenty-four, and those are separate decisions by this system’s own rule — so a mark that only changes colour leaves the eight pixels around it invisible until a press either lands or does not. The fill is the same one ButtonIcon uses for a button with no fill of its own, because it is the same button.
+  
+  A press darkens the fill further, and nothing moves. A scale would be the other way to say it, and on a mark this size it moves an edge by a pixel — cost without payoff. The fill also says something a one-shot animation cannot: it holds for as long as the button is held, which is what a stepper repeating ten times a second needs to show. The same two fills ButtonIcon uses, because it is the same button. Rendered only when `defaultValue` is set. Not rendered at all while `disabled`.
+- `helper` — `<span>`, class `dds-searchinput__helper`. Says what the field matches when its name does not imply it — "Searches references, amounts and dates" on a field called Search transactions. Stays on screen as the user types, which is the whole difference from the placeholder: a placeholder can only carry an example, because it goes at the first keystroke. Nothing ever replaces this, since nothing here reports a status. Rendered only when `helperText` is set.
+
+Apply these classes from the generated `searchInputParts` constant rather than writing the strings by hand.
+
+## Composition
+
+- Takes no children. Everything it renders comes from props
+- Never contains: `Button`, `TextInput` — in children or in any prop that takes a node
+
+## Props
+
+### size — `sm` | `md` | `lg` (default `md`)
+
+- `sm` — A search that is one control among several — a filter bar above a list, or a navigation row. Desktop layouts only: at thirty-two it is below what a finger reliably hits
+- `md` — The default — a search in a help centre's header, or above an index the page already holds
+- `lg` — A search that is the reason the section exists: a knowledge base landing page whose one job is to take a query
+
+### label — `string` **Required.**
+
+Use when: Always — a field announced as a searchbox still needs a name, and "Search" alone does not say what is being searched. "Search transactions", not "Search". Hide it with showLabel where the page has no room; it stays in the accessible tree either way
+Never for: The placeholder’s job. A placeholder may show an example of a query; the label says what the field searches, and it is the only one of the two a screen reader is given
+
+### showLabel — `boolean` (default `false`)
+
+Use when: Drawing the label, for a page-level search with a line to spend on it — a help centre, a directory. The exception rather than the rule: a toolbar and a table header show a magnifier and a placeholder. Drawing it also changes what the placeholder is for, since the label then says what is searched
+Never for: Deciding whether the field has a label. It always has one and it is always announced — this only says whether the label is drawn. Off is clipped, not removed
+
+### placeholder — `string`
+
+Use when: Making the field’s purpose legible while the label is clipped, which is the default and so the usual case: "Card, bank or wallet" on a payment method search. Draw the label and that job moves to it, leaving this free to show what a query looks like — "Skrill, Neteller, Maestro"
+Never for: The label, which it is not: it disappears as the user types and is never an accessible name. Nor repeating a drawn label, which is the same sentence twice
+
+### helperText — `string`
+
+Use when: Saying what the query matches when it is not obvious — "Searches names and symbols" on a field that looks like it searches only names. Stays on screen, unlike the placeholder
+Never for: How many results there are, or that there are none. That belongs to the list this field filters, which is the only thing that knows
+
+### value — `string`
+
+Use when: The page owns the query and passes it in — the controlled form, and the usual one here, because a query is normally held wherever the filtering happens
+
+### defaultValue — `string`
+
+Use when: A query the field starts on — a filter restored from a URL or a saved view. Absent means an empty field
+
+### onChange — `callback`
+
+Use when: Filtering as the user types. It reports the query as a string rather than the event, which is what every caller wanted from the event anyway — and it reports the same way whether the query was typed, cleared with the button or cleared with Escape
+Never for: Work that should wait for a pause. This fires on every keystroke; debouncing is the page's, because how long to wait depends on what the query costs. And never leave both this and onSearch unwired: a field reporting neither is one the reader types into while nothing happens, and which of the two to use is a decision rather than an option to skip. The contract cannot refuse it — a generated union can say one prop obliges another, not that one of two must be there
+
+### onSearch — `callback`
+
+Use when: Committing the query — Enter, and a query worth a round trip. A search that costs a request wants asking for, where one that filters a list already on screen can follow every keystroke through onChange
+Never for: Both jobs at once. A field wired to onSearch alone does nothing until Enter, which is right for a request and wrong for a filter — and one wired to both is asking the page to decide twice. Wiring neither is the other way to get it wrong: nothing is reported at all, and the field looks broken rather than quiet
+
+### clearLabel — `string` **Required.**
+
+Use when: Naming the clear button, which is always offered here rather than asked for. The glyph is a cross and says nothing on its own, so this is the button’s only name — "Clear search", in the consumer’s own words
+Never for: The label of the field. That names what is being searched; this names what pressing the button does to the query
+
+Also accepts everything from `InputHTMLAttributes<HTMLInputElement>`.
+
+## States
+
+States you set. Everything else is driven by the browser.
+
+- `disabled` — The list this field filters is not there to be filtered yet — still loading, or empty for a reason the page has already explained
+  Avoid when: The query is empty. There is nothing to validate here and nothing to wait for: an empty search field is a search field nobody has used yet
+
+## 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: `searchbox`
+- `Tab` — move focus
+- `Escape` — clear the query
+- `Enter` — commit the query
+- accessible name from label
+- aria-describedby pointing at helperText
+- the label stays in the accessible tree when showLabel is off — hidden from the page is not hidden from a screen reader
+
+## 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
+
+❌ SearchInput for: The field is part of a form the reader will submit
+   TextInput. A search commits on its own and clears on Escape, both of which are wrong inside a form: Escape would throw away something the reader was still filling in, and committing early submits a form that is not finished.
+   → nothing in this system does this. Not a gap waiting to be filled — the case belongs outside it.
+
+❌ SearchInput for: The set is small enough to show at once
+   A list, or a set of Tabs. A search over twelve items asks the reader to name what they could have pointed at, and an empty result is a worse answer than the twelve.
+   → nothing in this system does this. Not a gap waiting to be filled — the case belongs outside it.
+
+❌ SearchInput for: The reader is choosing from known options rather than describing what they want
+   Nothing here does this yet. Free text where a choice was meant has to be parsed, corrected and matched, and every mismatch is a query that finds nothing and reads as the site not having it.
+   → nothing in this system does this. Not a gap waiting to be filled — the case belongs outside it.
+
+## Example
+
+```tsx
+import { SearchInput } from '@deriv-com/dds-marketing'
+
+<SearchInput label="Search the help centre" clearLabel="Clear search" placeholder="Try 'withdrawal times'" helperText="Press Enter to search, Escape to clear." />
+```
+
+```tsx
+import { useState } from 'react'
+import { SearchInput } from '@deriv-com/dds-marketing'
+
+// Controlled: SearchInput reports the value, not the event.
+const [value, setValue] = useState('')
+<SearchInput label="Search the help centre" clearLabel="Clear search" placeholder="Try 'withdrawal times'" helperText="Press Enter to search, Escape to clear." value={value} onChange={setValue} onSearch={(query) => { /* your handler */ }} />
+```
+
+## In use
+
+### Three sizes, three jobs
+
+The small one is one control among several, in a filter bar or navigation row. The default sits in a header or above an index. The large one is for a page whose job is to take a query.
+
+```tsx
+import { SearchInput } from '@deriv-com/dds-marketing'
+
+// sm — one control in a filter bar
+<SearchInput label="Search the help centre" clearLabel="Clear search" placeholder="Try 'withdrawal times'" size="sm" />
+
+// md — in a help centre's header
+<SearchInput label="Search the help centre" clearLabel="Clear search" placeholder="Try 'withdrawal times'" size="md" />
+
+// lg — the page exists to take a query
+<SearchInput label="Search the help centre" clearLabel="Clear search" placeholder="Try 'withdrawal times'" size="lg" />
+```
+
+### Whether the label is drawn
+
+It always exists and is always announced. showLabel only says whether it is drawn — off is clipped from the page, never removed from the accessible tree.
+
+```tsx
+import { SearchInput } from '@deriv-com/dds-marketing'
+
+// Clipped — a magnifier and a placeholder
+<SearchInput label="Search the help centre" clearLabel="Clear search" placeholder="Try 'withdrawal times'" />
+
+// Drawn — a page with a line to spend on it
+<SearchInput label="Search the help centre" clearLabel="Clear search" placeholder="Try 'withdrawal times'" showLabel />
+```
+
+### Saying how the search behaves
+
+The helper is where a page says what a query will do, which matters most where the gesture is not obvious: Enter costs a round trip, Escape throws the query away.
+
+```tsx
+import { SearchInput } from '@deriv-com/dds-marketing'
+
+// What the two keys do
+<SearchInput label="Search the help centre" clearLabel="Clear search" placeholder="Try 'withdrawal times'" showLabel helperText="Press Enter to search, Escape to clear." />
+
+// What the search covers
+<SearchInput label="Search the help centre" clearLabel="Clear search" placeholder="Try 'withdrawal times'" showLabel helperText="Searches guides, FAQs and platform status." />
+```
+
+### A query already in the field
+
+The clear button appears as soon as there is something to clear and is never asked for: a search that cannot be emptied in one press is one nobody empties.
+
+```tsx
+import { SearchInput } from '@deriv-com/dds-marketing'
+
+// With a query, and the button that ends it
+<SearchInput label="Search the help centre" clearLabel="Clear search" placeholder="Try 'withdrawal times'" defaultValue="withdrawal times" />
+
+// Disabled — the button goes with the field
+<SearchInput label="Search the help centre" clearLabel="Clear search" placeholder="Try 'withdrawal times'" defaultValue="withdrawal times" disabled />
+```