Form
Search Field
A search input with a button that clears it, and Escape that does the same.
- Element
<slab-search-field>- Built on
<input type=search>
Example
Here's a styled version, <slab-styled-search-field>. It's not
in the package — it's an example of what you can build with the
headless element. Copy it and make it yours at the
bottom of this page. Switch to "As it ships" to see the same markup
with the headless element and no CSS at all. That's your starting
point.
<search>
<slab-styled-search-field label="Search the site log" placeholder="Pour, cure, strip…">
<span slot="description">Press Escape to clear it.</span>
</slab-styled-search-field>
</search>
<search>
<slab-search-field label="Search the site log" placeholder="Pour, cure, strip…">
<span slot="description">Press Escape to clear it.</span>
</slab-search-field>
</search>
Usage
pnpm add slab-elements lit
import 'slab-elements/search-field.js';
export function MySearchField() {
return (
<search>
<slab-search-field label="Search" name="q"></slab-search-field>
</search>
);
}
MySearchField.jsx React 19 or later, which sets props on custom elements as properties.
import 'slab-elements/search-field.js';
import { html, LitElement } from 'lit';
import { customElement } from 'lit/decorators.js';
@customElement('my-search-field')
export class MySearchField extends LitElement {
render() {
return html`
<search>
<slab-search-field label="Search" name="q"></slab-search-field>
</search>
`;
}
}
my-search-field.ts Slab is built on Lit, so its elements are at home in Lit's templates.
<script setup>
import 'slab-elements/search-field.js';
</script>
<template>
<search>
<slab-search-field label="Search" name="q"></slab-search-field>
</search>
</template>
MySearchField.vue Let Vue's compiler know slab- tags are custom elements with isCustomElement.
<script>
import 'slab-elements/search-field.js';
</script>
<search>
<slab-search-field label="Search" name="q"></slab-search-field>
</search>
MySearchField.svelte Svelte binds properties and events to custom elements like any other element.
import 'slab-elements/search-field.js';
export const MySearchField = <template>
<search>
<slab-search-field label="Search" name="q"></slab-search-field>
</search>
</template>;
MySearchField.gjs Ember sets attributes, and a dynamic value like {{this.max}} sets the property when the element has one. {{on}} listens for any event by its name.
<script type="module">
import 'slab-elements/search-field.js';
</script>
<search>
<slab-search-field label="Search" name="q"></slab-search-field>
</search>
index.html Any bundler (or an import map) takes care of the imports.
The input is a native search input, so screenreaders read it as a search box and phones show a search key. The clear button shows only while there’s something to clear and the field can be changed. It’s left out of the tab order, since Escape clears the input too, and clearing it puts focus back in the input and dispatches input and change the way typing does. The browser’s own clear button, which Chrome and Safari draw and Firefox doesn’t, is hidden so there’s one that works the same everywhere.
Escape clears in every browser, not only in those that do it natively. When the field is already empty, Escape is left alone, so a dialog or popover around it still closes. Wrap the field, or the form it’s in, in a <search> element to make a search landmark. Set clear-label to rename the button, or register searchFieldClear for another language.
selectionStart, selectionEnd, selectionDirection, select(), setSelectionRange() and setRangeText() work as they do on a native search input. Like a native input’s, setRangeText() dispatches no “input” or “change”.
Keyboard
| Key | What it does |
|---|---|
| Escape | Clears the input. When it’s already empty, does nothing, so it reaches what’s around the field. |
| Enter | Submits the form. |
| Anything else | What it does on a native search input. |
Behavior
A search field with no visual styles, around a native search input, and a button beside it that clears what's been typed.
The input is type="search", so screenreaders read it as a search box and phones show a search key. The browser's own clear button, which only some browsers draw, is hidden so there's one that works the same everywhere. Slab's is only there while there's something to clear and the field can be changed. It's left out of the tab order, as Escape does the same from the input, so tabbing goes from the search straight to whatever's after it. Clearing focuses the input again and dispatches "input" and "change", as typing does.
Escape clears the input in every browser, not only in those that do it natively. When there's nothing to clear, Escape is left alone, so a dialog or popover the field is in still closes on it.
Put it in a <search> element, or a <form role="search">, to make a search landmark. The landmark belongs around the whole search, not the field.
The label and the input are both in the shadow root, so a plain for reference names it without crossing out of one. The host delegates focus, so clicking anywhere on it, or a <label for> pointing at it, focuses the input.
Validity is the native input's. required, minlength, maxlength and pattern are passed through to it, and whatever it decides is mirrored onto the host, so valueMissing, tooShort and patternMismatch all mean what they mean on an <input>. Nothing is computed twice.
Style it through its parts and through :state(disabled), :state(error), :state(empty), :state(readonly) and :state(required). Where the label sits relative to the input, and the button relative to it, is layout, so it's left to the styles around it.
API
<slab-search-field>
| Name | Type | Default | Description |
|---|---|---|---|
label
Required
|
string |
Names it. It's the accessible name, and the visible label where there is one. | |
autocomplete
|
HTMLInputElement['autocomplete'] |
What the browser may fill it with, as a native input's autocomplete says. |
|
clear-label
|
string |
The clear button's text and so its accessible name. "Clear search" in English when unset. | |
disabled
|
boolean |
false |
Disables it, as disabled does a native control: the user can't focus or use it, and a form control's value isn't submitted. |
hide-label
|
boolean |
false |
Hides the label visually and leaves it as the accessible name, for a design that shows the label some other way. |
maxlength
|
number |
The most characters the user can type, as a native input's maxlength. |
|
minlength
|
number |
The fewest characters a valid value has, as a native input's minlength. |
|
name
|
string |
'' |
The name its value is submitted under, as a native control's name. |
pattern
|
string |
A regular expression a valid value matches, as a native input's pattern. |
|
placeholder
|
string |
Shown while it's empty, as a native input's placeholder. It's a hint, not a label. |
|
readonly
|
boolean |
false |
Lets the user select the value but not change it, as readonly does a native input. The value is still submitted. |
required
|
boolean |
false |
Makes it invalid while it has no value, as required does a native control. |
value
|
string |
'' |
Like a native input, the attribute is the default value and the property is the current one, so the attribute doesn't change as the field is typed into. |
custom-validity
|
string |
Makes it invalid with this message, as setCustomValidity() does, and shows the message at once rather than once validity is reported, for an error the page already knows about, such as one from a server. Removing it, or setting it to an empty string, makes it valid again, unless something else makes it invalid. |
| Name | Type | Description |
|---|---|---|
defaultValue
|
string |
The value it starts with, and goes back to when its form resets. It's the value attribute, as a native input's defaultValue is, so setting it sets the attribute, and value with it. |
selectionDirection
|
HTMLInputElement['selectionDirection'] |
Which way the selection was made, "forward", "backward" or "none", as a native input's selectionDirection is. |
selectionEnd
|
number | null |
Where the selection ends, or where the caret is when nothing is selected, as a native input's selectionEnd is. |
selectionStart
|
number | null |
Where the selection starts, or where the caret is when nothing is selected, as a native input's selectionStart is. |
form
Read-only
|
HTMLFormElement | null |
The form it belongs to, or null. |
labels
Read-only
|
NodeList |
The <label> elements associated with it, as a native control's labels: each <label for> that names its id, and a <label> around it. |
validationMessage
Read-only
|
string |
What's wrong, as the validity message says it: the message given to setCustomValidity() or setValidity(), or else the browser's own. Empty while it's valid. |
validity
Read-only
|
ValidityState |
Its ValidityState, as a native control's. |
willValidate
Read-only
|
boolean |
Whether its validity is checked when its form submits. It isn't while it's disabled or read-only. |
| Signature | Description |
|---|---|
checkValidity(): boolean
|
Whether its value is valid. Dispatches "invalid" when it isn't, as a native control's does. |
click(): void
|
Clicks it, as a native element's click() does. |
focus(options?: FocusOptions): void
|
Focuses it, or the part of it that takes focus. |
reportValidity(): boolean
|
Whether its value is valid. When it isn't, dispatches "invalid" and shows the validity message, as a native control's does. |
resetValidityFeedback(): void
|
Clears the validity feedback without changing validity. |
select(): void
|
Selects its text, as a native input's select() does. |
setCustomValidity(message: string): void
|
Makes it invalid with a message of your own, or valid again with an empty one, as a native control's does. |
setRangeText(replacement: string, start?: number, end?: number, selectionMode?: SelectionMode): void
|
Replaces part of its text, or the selection when start and end are left out, as a native input's setRangeText() does. selectionMode says what's selected afterward: "select", "start", "end" or "preserve", the default. Like a native input's, it dispatches no "input" or "change". |
setSelectionRange(start: number, end: number, direction?: 'forward' | 'backward' | 'none'): void
|
Selects part of its text, as a native input's setSelectionRange() does. |
setValidity(flags?: ValidityStateFlags, message?: string): void
|
Sets its validity and message, as ElementInternals.setValidity() does, for checks of your own beyond setCustomValidity(). |
| Name | Type | Description |
|---|---|---|
input
|
Event |
As the user changes its value, as a native control's does. Setting it from code doesn't dispatch it. |
change
|
Event |
When the user changes its value, as a native control's does. Setting it from code doesn't dispatch it. |
invalid
|
Event |
When a check finds its value invalid, as a native control's does. Cancel it to leave the validity message unshown, after a blur, a submit or reportValidity(), and focus where it is. |
| Name | Type | Description |
|---|---|---|
description
|
Element | string |
Text that describes it, such as a hint or what the validity message means. It's its accessible description. |
validity-message
|
Element | string |
Shown in place of the validity message's text while it's invalid and the message shows, for wording of your own, a translation, or a link. It's part of its accessible description, and validationMessage stays the browser's or setCustomValidity()'s. |
| Name | Description |
|---|---|
clear-button
|
The button that clears the input |
control
|
The input and the button, together |
description
|
Text about the field, and its validity message when it has one |
input
|
The input |
label
|
The label |
validity-message
|
The validity message, which says why the value is invalid |
| Name | Description |
|---|---|
:state(disabled)
|
While it's disabled. |
:state(empty)
|
While it has no value. |
:state(error)
|
While it's invalid and its validity message shows, which is once its validity is reported, as when its form is submitted. |
:state(readonly)
|
While it's read-only. |
:state(required)
|
While it's required, for styles such as an asterisk. |
Copy and own it
<slab-styled-search-field> isn't in the package. It's an example —
copy it into your project and change whatever you want. Keyboard,
focus, ARIA, forms, and events all come from the headless element,
and the styles only reach in through ::part() and
:state(), same as yours would.
The same styles, written from outside the element, so
there's nothing to subclass. The CSS styles every
<slab-search-field> on the page. Import
tokens.css, the colors and fonts every styled
example shares, once, wherever your global styles go.
Each component registers its headless element and imports its CSS. Use it like the element: its props are the element's attributes and properties.
SearchField.jsx
import 'slab-elements/search-field.js';
import './search-field.css';
export function SearchField(props) {
return <slab-search-field {...props} />;
}
search-field.css
slab-search-field {
color: var(--ink);
display: grid;
font-family: var(--font-body);
}
slab-search-field::part(label) {
font-family: var(--font-display);
font-size: 1.0625rem;
font-weight: 600;
margin-block-end: 0.375rem;
}
slab-search-field:state(required)::part(label)::after {
color: var(--ember-deep);
content: ' *' / '';
}
slab-search-field::part(input),
slab-search-field::part(textarea) {
background-color: var(--paper);
block-size: 3rem;
border: var(--border);
border-radius: 0;
box-sizing: border-box;
color: inherit;
font: inherit;
/* A fixed height, shared with Select, so fields line up in a row. */
padding: 0 0.75rem;
transition:
background-color 100ms,
border-color 100ms,
box-shadow 100ms,
translate 100ms;
}
slab-search-field::part(input)::placeholder,
slab-search-field::part(textarea)::placeholder {
color: var(--ash);
}
/*
The outline is transparent rather than gone, so it still shows in forced
colors, where box shadows don't.
*/
slab-search-field::part(input):focus-visible,
slab-search-field::part(textarea):focus-visible {
box-shadow: 4px 4px 0 var(--ember);
outline: 2px solid transparent;
translate: -2px -2px;
}
slab-search-field::part(input):disabled,
slab-search-field::part(textarea):disabled {
background-color: var(--chalk);
border-style: dashed;
color: var(--ash);
cursor: not-allowed;
}
slab-search-field::part(textarea) {
block-size: auto;
min-block-size: 7rem;
padding: 0.625rem 0.75rem;
resize: vertical;
}
slab-search-field:state(readonly)::part(input),
slab-search-field:state(readonly)::part(textarea) {
background-color: var(--chalk);
}
slab-search-field:state(error)::part(input),
slab-search-field:state(error)::part(textarea) {
border-color: var(--ember-deep);
}
/*
Spaced by what's in it rather than by a gap, so a description with
nothing in it takes no room, and a control beside the field lines up
with its bottom edge.
*/
slab-search-field::part(description) {
color: var(--ash);
display: grid;
font-size: 0.875rem;
}
slab-search-field > [slot='description'] {
margin-block-start: 0.375rem;
}
slab-search-field::part(validity-message) {
color: var(--ember-deep);
font-weight: 600;
margin-block-start: 0.375rem;
}
slab-search-field::part(validity-message)::before {
content: '■ ' / '';
}
@media (prefers-reduced-motion: reduce) {
slab-search-field::part(input),
slab-search-field::part(textarea) {
transition: none;
}
}
slab-search-field::part(control) {
display: grid;
grid-template-columns: minmax(0, 1fr) auto;
}
/* Safari rounds a search input's corners unless it's told not to. */
slab-search-field::part(input) {
appearance: none;
}
/*
Butted against the input, sharing its border, at the same fixed height.
*/
slab-search-field::part(clear-button) {
background-color: var(--paper);
block-size: 3rem;
border: var(--border);
border-radius: 0;
color: inherit;
cursor: pointer;
font-family: var(--font-mono);
font-size: 0.8125rem;
letter-spacing: 0.06em;
margin-inline-start: -2px;
padding: 0 0.875rem;
text-transform: uppercase;
transition:
background-color 100ms,
box-shadow 100ms,
color 100ms,
translate 100ms;
}
slab-search-field::part(clear-button):hover {
background-color: var(--chalk);
}
/*
The outline is transparent rather than gone, so it still shows in forced
colors, where box shadows don't.
*/
slab-search-field::part(clear-button):focus-visible {
box-shadow: 4px 4px 0 var(--ember);
outline: 2px solid transparent;
translate: -2px -2px;
}
slab-search-field:state(error)::part(clear-button) {
border-color: var(--ember-deep);
}
@media (prefers-reduced-motion: reduce) {
slab-search-field::part(clear-button) {
transition: none;
}
}
tokens.css
:root {
/* Secondary text. 6.8:1 and 6.9:1 on paper. */
--ash: var(--slab-styled-ash, light-dark(#5e5a55, #a8a19a));
--border: 2px solid var(--ink);
/* Behind disabled and read-only controls, and hovered rows. */
--chalk: var(--slab-styled-chalk, light-dark(#f4f1ec, #2b2926));
/*
The logo's orange, brighter in the dark. 4.25:1 and 5.2:1 on paper is
enough for borders, fills and large text, but not always for small text,
which takes "--ember-deep".
*/
--ember: var(--slab-styled-ember, light-dark(#d9492a, #ec5f3b));
/*
Orange for small text on paper, and for paper text on it. 5.7:1 and
7.4:1.
*/
--ember-deep: var(--slab-styled-ember-deep, light-dark(#b3381a, #ff8566));
--font-body: var(
--slab-styled-font-body,
'IBM Plex Sans',
system-ui,
sans-serif
);
--font-display: var(
--slab-styled-font-display,
'Zilla Slab',
rockwell,
'Roboto Slab',
serif
);
--font-mono: var(
--slab-styled-font-mono,
'IBM Plex Mono',
ui-monospace,
monospace
);
--ink: var(--slab-styled-ink, light-dark(#1c1c1c, #f4f1ec));
--paper: var(--slab-styled-paper, light-dark(#fff, #1a1918));
/* The hard, offset shadow a raised surface casts. */
--shadow: 4px 4px 0 var(--ink);
}
/*
Forced colors, such as Windows' contrast themes, replace every color that
isn't a system color, so ember fills and paper marks all become the same
background, and a checked Checkbox looks like an unchecked one. The palette
becomes the user's system colors instead, which are kept. Ember is the
highlight, the color of what's selected, and ember-deep, being for text and
for paper text on it, is the text color.
*/
@media (forced-colors: active) {
:host {
--ash: GrayText;
--chalk: Canvas;
--ember: Highlight;
--ember-deep: CanvasText;
--ink: CanvasText;
--paper: Canvas;
}
}
Under the hood, it's just the headless element, subclassed,
with styles set. That's it. To use it, copy
these files, swap the tag in @customElement()
for one of your own, and import it.
tokens.styles.ts holds the colors and fonts
every styled example shares, so you only need it once.
search-field.ts
import { customElement } from 'lit/decorators.js';
import SearchField from 'slab-elements/search-field.js';
import styles from './search-field.styles.js';
import textInput from './text-input.styles.js';
import tokens from './tokens.styles.js';
declare global {
interface HTMLElementTagNameMap {
'slab-styled-search-field': StyledSearchField;
}
}
/**
* Search Field, styled: Text Field's input with its clear button butted
* against it while there's something to clear.
*/
@customElement('slab-styled-search-field')
export default class StyledSearchField extends SearchField {
static override styles = [tokens, textInput, styles];
}
search-field.styles.ts
import { css } from 'lit';
export default css`
[part~='control'] {
display: grid;
grid-template-columns: minmax(0, 1fr) auto;
}
/* Safari rounds a search input's corners unless it's told not to. */
[part~='input'] {
appearance: none;
}
/*
Butted against the input, sharing its border, at the same fixed height.
*/
[part~='clear-button'] {
background-color: var(--paper);
block-size: 3rem;
border: var(--border);
border-radius: 0;
color: inherit;
cursor: pointer;
font-family: var(--font-mono);
font-size: 0.8125rem;
letter-spacing: 0.06em;
margin-inline-start: -2px;
padding: 0 0.875rem;
text-transform: uppercase;
transition:
background-color 100ms,
box-shadow 100ms,
color 100ms,
translate 100ms;
&:hover {
background-color: var(--chalk);
}
/*
The outline is transparent rather than gone, so it still shows in forced
colors, where box shadows don't.
*/
&:focus-visible {
box-shadow: 4px 4px 0 var(--ember);
outline: 2px solid transparent;
translate: -2px -2px;
}
}
:host(:state(error)) [part~='clear-button'] {
border-color: var(--ember-deep);
}
@media (prefers-reduced-motion: reduce) {
[part~='clear-button'] {
transition: none;
}
}
`;
text-input.styles.ts
import { css } from 'lit';
/*
The look shared by everything typed into: Text Field, Password Field,
Search Field, Textarea, Number, Date Field, Time Field, Combobox and Tags
Input, whose fields are "::part(input)", or "::part(textarea)" for Textarea.
File Drop starts from it too, for its label and description.
*/
export default css`
:host {
color: var(--ink);
display: grid;
font-family: var(--font-body);
}
[part~='label'] {
font-family: var(--font-display);
font-size: 1.0625rem;
font-weight: 600;
margin-block-end: 0.375rem;
}
:host(:state(required)) [part~='label']::after {
color: var(--ember-deep);
content: ' *' / '';
}
[part~='input'],
[part~='textarea'] {
background-color: var(--paper);
block-size: 3rem;
border: var(--border);
border-radius: 0;
box-sizing: border-box;
color: inherit;
font: inherit;
/* A fixed height, shared with Select, so fields line up in a row. */
padding: 0 0.75rem;
transition:
background-color 100ms,
border-color 100ms,
box-shadow 100ms,
translate 100ms;
&::placeholder {
color: var(--ash);
}
/*
The outline is transparent rather than gone, so it still shows in forced
colors, where box shadows don't.
*/
&:focus-visible {
box-shadow: 4px 4px 0 var(--ember);
outline: 2px solid transparent;
translate: -2px -2px;
}
&:disabled {
background-color: var(--chalk);
border-style: dashed;
color: var(--ash);
cursor: not-allowed;
}
}
[part~='textarea'] {
block-size: auto;
min-block-size: 7rem;
padding: 0.625rem 0.75rem;
resize: vertical;
}
:host(:state(readonly)) [part~='input'],
:host(:state(readonly)) [part~='textarea'] {
background-color: var(--chalk);
}
:host(:state(error)) [part~='input'],
:host(:state(error)) [part~='textarea'] {
border-color: var(--ember-deep);
}
/*
Spaced by what's in it rather than by a gap, so a description with
nothing in it takes no room, and a control beside the field lines up
with its bottom edge.
*/
[part~='description'] {
color: var(--ash);
display: grid;
font-size: 0.875rem;
}
::slotted([slot='description']) {
margin-block-start: 0.375rem;
}
[part~='validity-message'] {
color: var(--ember-deep);
font-weight: 600;
margin-block-start: 0.375rem;
&::before {
content: '■ ' / '';
}
}
@media (prefers-reduced-motion: reduce) {
[part~='input'],
[part~='textarea'] {
transition: none;
}
}
`;
tokens.styles.ts
import { css } from 'lit';
/*
The styled components' palette and type, taken from the logo: ink for the
courses, ember for the base, paper behind them.
Each is a short alias for a "--slab-styled-*" property, with the default as
its fallback. Retheming is "--slab-styled-ember" and the rest on ":root",
which every shadow root inherits. Were the defaults declared under those
names here instead, each host's own declaration would shadow the page's.
Each default is "light-dark()", so the components follow the page's
"color-scheme": "dark" for dark, "light" for light, and "light dark" to
follow the operating system. Ink and paper trade places in the dark, so
ink is always the text and paper always what's behind it. Contrast is given
as light, then dark.
*/
export default css`
:host {
/* Secondary text. 6.8:1 and 6.9:1 on paper. */
--ash: var(--slab-styled-ash, light-dark(#5e5a55, #a8a19a));
--border: 2px solid var(--ink);
/* Behind disabled and read-only controls, and hovered rows. */
--chalk: var(--slab-styled-chalk, light-dark(#f4f1ec, #2b2926));
/*
The logo's orange, brighter in the dark. 4.25:1 and 5.2:1 on paper is
enough for borders, fills and large text, but not always for small text,
which takes "--ember-deep".
*/
--ember: var(--slab-styled-ember, light-dark(#d9492a, #ec5f3b));
/*
Orange for small text on paper, and for paper text on it. 5.7:1 and
7.4:1.
*/
--ember-deep: var(--slab-styled-ember-deep, light-dark(#b3381a, #ff8566));
--font-body: var(
--slab-styled-font-body,
'IBM Plex Sans',
system-ui,
sans-serif
);
--font-display: var(
--slab-styled-font-display,
'Zilla Slab',
rockwell,
'Roboto Slab',
serif
);
--font-mono: var(
--slab-styled-font-mono,
'IBM Plex Mono',
ui-monospace,
monospace
);
--ink: var(--slab-styled-ink, light-dark(#1c1c1c, #f4f1ec));
--paper: var(--slab-styled-paper, light-dark(#fff, #1a1918));
/* The hard, offset shadow a raised surface casts. */
--shadow: 4px 4px 0 var(--ink);
}
/*
Forced colors, such as Windows' contrast themes, replace every color that
isn't a system color, so ember fills and paper marks all become the same
background, and a checked Checkbox looks like an unchecked one. The palette
becomes the user's system colors instead, which are kept. Ember is the
highlight, the color of what's selected, and ember-deep, being for text and
for paper text on it, is the text color.
*/
@media (forced-colors: active) {
:host {
--ash: GrayText;
--chalk: Canvas;
--ember: Highlight;
--ember-deep: CanvasText;
--ink: CanvasText;
--paper: Canvas;
}
}
`;
The same styles, written from outside the element, so
there's nothing to subclass. The CSS styles every
<slab-search-field> on the page. Import
tokens.css, the colors and fonts every styled
example shares, once, wherever your global styles go.
Each component registers its headless element and imports its CSS. Use it like the element: its props are the element's attributes and properties.
SearchField.vue
<script setup>
import 'slab-elements/search-field.js';
import './search-field.css';
</script>
<template>
<slab-search-field><slot /></slab-search-field>
</template>
search-field.css
slab-search-field {
color: var(--ink);
display: grid;
font-family: var(--font-body);
}
slab-search-field::part(label) {
font-family: var(--font-display);
font-size: 1.0625rem;
font-weight: 600;
margin-block-end: 0.375rem;
}
slab-search-field:state(required)::part(label)::after {
color: var(--ember-deep);
content: ' *' / '';
}
slab-search-field::part(input),
slab-search-field::part(textarea) {
background-color: var(--paper);
block-size: 3rem;
border: var(--border);
border-radius: 0;
box-sizing: border-box;
color: inherit;
font: inherit;
/* A fixed height, shared with Select, so fields line up in a row. */
padding: 0 0.75rem;
transition:
background-color 100ms,
border-color 100ms,
box-shadow 100ms,
translate 100ms;
}
slab-search-field::part(input)::placeholder,
slab-search-field::part(textarea)::placeholder {
color: var(--ash);
}
/*
The outline is transparent rather than gone, so it still shows in forced
colors, where box shadows don't.
*/
slab-search-field::part(input):focus-visible,
slab-search-field::part(textarea):focus-visible {
box-shadow: 4px 4px 0 var(--ember);
outline: 2px solid transparent;
translate: -2px -2px;
}
slab-search-field::part(input):disabled,
slab-search-field::part(textarea):disabled {
background-color: var(--chalk);
border-style: dashed;
color: var(--ash);
cursor: not-allowed;
}
slab-search-field::part(textarea) {
block-size: auto;
min-block-size: 7rem;
padding: 0.625rem 0.75rem;
resize: vertical;
}
slab-search-field:state(readonly)::part(input),
slab-search-field:state(readonly)::part(textarea) {
background-color: var(--chalk);
}
slab-search-field:state(error)::part(input),
slab-search-field:state(error)::part(textarea) {
border-color: var(--ember-deep);
}
/*
Spaced by what's in it rather than by a gap, so a description with
nothing in it takes no room, and a control beside the field lines up
with its bottom edge.
*/
slab-search-field::part(description) {
color: var(--ash);
display: grid;
font-size: 0.875rem;
}
slab-search-field > [slot='description'] {
margin-block-start: 0.375rem;
}
slab-search-field::part(validity-message) {
color: var(--ember-deep);
font-weight: 600;
margin-block-start: 0.375rem;
}
slab-search-field::part(validity-message)::before {
content: '■ ' / '';
}
@media (prefers-reduced-motion: reduce) {
slab-search-field::part(input),
slab-search-field::part(textarea) {
transition: none;
}
}
slab-search-field::part(control) {
display: grid;
grid-template-columns: minmax(0, 1fr) auto;
}
/* Safari rounds a search input's corners unless it's told not to. */
slab-search-field::part(input) {
appearance: none;
}
/*
Butted against the input, sharing its border, at the same fixed height.
*/
slab-search-field::part(clear-button) {
background-color: var(--paper);
block-size: 3rem;
border: var(--border);
border-radius: 0;
color: inherit;
cursor: pointer;
font-family: var(--font-mono);
font-size: 0.8125rem;
letter-spacing: 0.06em;
margin-inline-start: -2px;
padding: 0 0.875rem;
text-transform: uppercase;
transition:
background-color 100ms,
box-shadow 100ms,
color 100ms,
translate 100ms;
}
slab-search-field::part(clear-button):hover {
background-color: var(--chalk);
}
/*
The outline is transparent rather than gone, so it still shows in forced
colors, where box shadows don't.
*/
slab-search-field::part(clear-button):focus-visible {
box-shadow: 4px 4px 0 var(--ember);
outline: 2px solid transparent;
translate: -2px -2px;
}
slab-search-field:state(error)::part(clear-button) {
border-color: var(--ember-deep);
}
@media (prefers-reduced-motion: reduce) {
slab-search-field::part(clear-button) {
transition: none;
}
}
tokens.css
:root {
/* Secondary text. 6.8:1 and 6.9:1 on paper. */
--ash: var(--slab-styled-ash, light-dark(#5e5a55, #a8a19a));
--border: 2px solid var(--ink);
/* Behind disabled and read-only controls, and hovered rows. */
--chalk: var(--slab-styled-chalk, light-dark(#f4f1ec, #2b2926));
/*
The logo's orange, brighter in the dark. 4.25:1 and 5.2:1 on paper is
enough for borders, fills and large text, but not always for small text,
which takes "--ember-deep".
*/
--ember: var(--slab-styled-ember, light-dark(#d9492a, #ec5f3b));
/*
Orange for small text on paper, and for paper text on it. 5.7:1 and
7.4:1.
*/
--ember-deep: var(--slab-styled-ember-deep, light-dark(#b3381a, #ff8566));
--font-body: var(
--slab-styled-font-body,
'IBM Plex Sans',
system-ui,
sans-serif
);
--font-display: var(
--slab-styled-font-display,
'Zilla Slab',
rockwell,
'Roboto Slab',
serif
);
--font-mono: var(
--slab-styled-font-mono,
'IBM Plex Mono',
ui-monospace,
monospace
);
--ink: var(--slab-styled-ink, light-dark(#1c1c1c, #f4f1ec));
--paper: var(--slab-styled-paper, light-dark(#fff, #1a1918));
/* The hard, offset shadow a raised surface casts. */
--shadow: 4px 4px 0 var(--ink);
}
/*
Forced colors, such as Windows' contrast themes, replace every color that
isn't a system color, so ember fills and paper marks all become the same
background, and a checked Checkbox looks like an unchecked one. The palette
becomes the user's system colors instead, which are kept. Ember is the
highlight, the color of what's selected, and ember-deep, being for text and
for paper text on it, is the text color.
*/
@media (forced-colors: active) {
:host {
--ash: GrayText;
--chalk: Canvas;
--ember: Highlight;
--ember-deep: CanvasText;
--ink: CanvasText;
--paper: Canvas;
}
}
The same styles, written from outside the element, so
there's nothing to subclass. The CSS styles every
<slab-search-field> on the page. Import
tokens.css, the colors and fonts every styled
example shares, once, wherever your global styles go.
Import search-field.js once, such
as in your root layout, and use
<slab-search-field> as is. A Svelte component
around it would take slot="…" content as its
own slot and drop it.
search-field.js
import 'slab-elements/search-field.js';
import './search-field.css';
search-field.css
slab-search-field {
color: var(--ink);
display: grid;
font-family: var(--font-body);
}
slab-search-field::part(label) {
font-family: var(--font-display);
font-size: 1.0625rem;
font-weight: 600;
margin-block-end: 0.375rem;
}
slab-search-field:state(required)::part(label)::after {
color: var(--ember-deep);
content: ' *' / '';
}
slab-search-field::part(input),
slab-search-field::part(textarea) {
background-color: var(--paper);
block-size: 3rem;
border: var(--border);
border-radius: 0;
box-sizing: border-box;
color: inherit;
font: inherit;
/* A fixed height, shared with Select, so fields line up in a row. */
padding: 0 0.75rem;
transition:
background-color 100ms,
border-color 100ms,
box-shadow 100ms,
translate 100ms;
}
slab-search-field::part(input)::placeholder,
slab-search-field::part(textarea)::placeholder {
color: var(--ash);
}
/*
The outline is transparent rather than gone, so it still shows in forced
colors, where box shadows don't.
*/
slab-search-field::part(input):focus-visible,
slab-search-field::part(textarea):focus-visible {
box-shadow: 4px 4px 0 var(--ember);
outline: 2px solid transparent;
translate: -2px -2px;
}
slab-search-field::part(input):disabled,
slab-search-field::part(textarea):disabled {
background-color: var(--chalk);
border-style: dashed;
color: var(--ash);
cursor: not-allowed;
}
slab-search-field::part(textarea) {
block-size: auto;
min-block-size: 7rem;
padding: 0.625rem 0.75rem;
resize: vertical;
}
slab-search-field:state(readonly)::part(input),
slab-search-field:state(readonly)::part(textarea) {
background-color: var(--chalk);
}
slab-search-field:state(error)::part(input),
slab-search-field:state(error)::part(textarea) {
border-color: var(--ember-deep);
}
/*
Spaced by what's in it rather than by a gap, so a description with
nothing in it takes no room, and a control beside the field lines up
with its bottom edge.
*/
slab-search-field::part(description) {
color: var(--ash);
display: grid;
font-size: 0.875rem;
}
slab-search-field > [slot='description'] {
margin-block-start: 0.375rem;
}
slab-search-field::part(validity-message) {
color: var(--ember-deep);
font-weight: 600;
margin-block-start: 0.375rem;
}
slab-search-field::part(validity-message)::before {
content: '■ ' / '';
}
@media (prefers-reduced-motion: reduce) {
slab-search-field::part(input),
slab-search-field::part(textarea) {
transition: none;
}
}
slab-search-field::part(control) {
display: grid;
grid-template-columns: minmax(0, 1fr) auto;
}
/* Safari rounds a search input's corners unless it's told not to. */
slab-search-field::part(input) {
appearance: none;
}
/*
Butted against the input, sharing its border, at the same fixed height.
*/
slab-search-field::part(clear-button) {
background-color: var(--paper);
block-size: 3rem;
border: var(--border);
border-radius: 0;
color: inherit;
cursor: pointer;
font-family: var(--font-mono);
font-size: 0.8125rem;
letter-spacing: 0.06em;
margin-inline-start: -2px;
padding: 0 0.875rem;
text-transform: uppercase;
transition:
background-color 100ms,
box-shadow 100ms,
color 100ms,
translate 100ms;
}
slab-search-field::part(clear-button):hover {
background-color: var(--chalk);
}
/*
The outline is transparent rather than gone, so it still shows in forced
colors, where box shadows don't.
*/
slab-search-field::part(clear-button):focus-visible {
box-shadow: 4px 4px 0 var(--ember);
outline: 2px solid transparent;
translate: -2px -2px;
}
slab-search-field:state(error)::part(clear-button) {
border-color: var(--ember-deep);
}
@media (prefers-reduced-motion: reduce) {
slab-search-field::part(clear-button) {
transition: none;
}
}
tokens.css
:root {
/* Secondary text. 6.8:1 and 6.9:1 on paper. */
--ash: var(--slab-styled-ash, light-dark(#5e5a55, #a8a19a));
--border: 2px solid var(--ink);
/* Behind disabled and read-only controls, and hovered rows. */
--chalk: var(--slab-styled-chalk, light-dark(#f4f1ec, #2b2926));
/*
The logo's orange, brighter in the dark. 4.25:1 and 5.2:1 on paper is
enough for borders, fills and large text, but not always for small text,
which takes "--ember-deep".
*/
--ember: var(--slab-styled-ember, light-dark(#d9492a, #ec5f3b));
/*
Orange for small text on paper, and for paper text on it. 5.7:1 and
7.4:1.
*/
--ember-deep: var(--slab-styled-ember-deep, light-dark(#b3381a, #ff8566));
--font-body: var(
--slab-styled-font-body,
'IBM Plex Sans',
system-ui,
sans-serif
);
--font-display: var(
--slab-styled-font-display,
'Zilla Slab',
rockwell,
'Roboto Slab',
serif
);
--font-mono: var(
--slab-styled-font-mono,
'IBM Plex Mono',
ui-monospace,
monospace
);
--ink: var(--slab-styled-ink, light-dark(#1c1c1c, #f4f1ec));
--paper: var(--slab-styled-paper, light-dark(#fff, #1a1918));
/* The hard, offset shadow a raised surface casts. */
--shadow: 4px 4px 0 var(--ink);
}
/*
Forced colors, such as Windows' contrast themes, replace every color that
isn't a system color, so ember fills and paper marks all become the same
background, and a checked Checkbox looks like an unchecked one. The palette
becomes the user's system colors instead, which are kept. Ember is the
highlight, the color of what's selected, and ember-deep, being for text and
for paper text on it, is the text color.
*/
@media (forced-colors: active) {
:host {
--ash: GrayText;
--chalk: Canvas;
--ember: Highlight;
--ember-deep: CanvasText;
--ink: CanvasText;
--paper: Canvas;
}
}
The same styles, written from outside the element, so
there's nothing to subclass. The CSS styles every
<slab-search-field> on the page. Import
tokens.css, the colors and fonts every styled
example shares, once, wherever your global styles go.
Each component registers its headless element and imports its CSS. Use it like the element: its attributes and its content go to the element.
SearchField.gjs
import 'slab-elements/search-field.js';
import './search-field.css';
export const SearchField = <template>
<slab-search-field ...attributes>{{yield}}</slab-search-field>
</template>;
search-field.css
slab-search-field {
color: var(--ink);
display: grid;
font-family: var(--font-body);
}
slab-search-field::part(label) {
font-family: var(--font-display);
font-size: 1.0625rem;
font-weight: 600;
margin-block-end: 0.375rem;
}
slab-search-field:state(required)::part(label)::after {
color: var(--ember-deep);
content: ' *' / '';
}
slab-search-field::part(input),
slab-search-field::part(textarea) {
background-color: var(--paper);
block-size: 3rem;
border: var(--border);
border-radius: 0;
box-sizing: border-box;
color: inherit;
font: inherit;
/* A fixed height, shared with Select, so fields line up in a row. */
padding: 0 0.75rem;
transition:
background-color 100ms,
border-color 100ms,
box-shadow 100ms,
translate 100ms;
}
slab-search-field::part(input)::placeholder,
slab-search-field::part(textarea)::placeholder {
color: var(--ash);
}
/*
The outline is transparent rather than gone, so it still shows in forced
colors, where box shadows don't.
*/
slab-search-field::part(input):focus-visible,
slab-search-field::part(textarea):focus-visible {
box-shadow: 4px 4px 0 var(--ember);
outline: 2px solid transparent;
translate: -2px -2px;
}
slab-search-field::part(input):disabled,
slab-search-field::part(textarea):disabled {
background-color: var(--chalk);
border-style: dashed;
color: var(--ash);
cursor: not-allowed;
}
slab-search-field::part(textarea) {
block-size: auto;
min-block-size: 7rem;
padding: 0.625rem 0.75rem;
resize: vertical;
}
slab-search-field:state(readonly)::part(input),
slab-search-field:state(readonly)::part(textarea) {
background-color: var(--chalk);
}
slab-search-field:state(error)::part(input),
slab-search-field:state(error)::part(textarea) {
border-color: var(--ember-deep);
}
/*
Spaced by what's in it rather than by a gap, so a description with
nothing in it takes no room, and a control beside the field lines up
with its bottom edge.
*/
slab-search-field::part(description) {
color: var(--ash);
display: grid;
font-size: 0.875rem;
}
slab-search-field > [slot='description'] {
margin-block-start: 0.375rem;
}
slab-search-field::part(validity-message) {
color: var(--ember-deep);
font-weight: 600;
margin-block-start: 0.375rem;
}
slab-search-field::part(validity-message)::before {
content: '■ ' / '';
}
@media (prefers-reduced-motion: reduce) {
slab-search-field::part(input),
slab-search-field::part(textarea) {
transition: none;
}
}
slab-search-field::part(control) {
display: grid;
grid-template-columns: minmax(0, 1fr) auto;
}
/* Safari rounds a search input's corners unless it's told not to. */
slab-search-field::part(input) {
appearance: none;
}
/*
Butted against the input, sharing its border, at the same fixed height.
*/
slab-search-field::part(clear-button) {
background-color: var(--paper);
block-size: 3rem;
border: var(--border);
border-radius: 0;
color: inherit;
cursor: pointer;
font-family: var(--font-mono);
font-size: 0.8125rem;
letter-spacing: 0.06em;
margin-inline-start: -2px;
padding: 0 0.875rem;
text-transform: uppercase;
transition:
background-color 100ms,
box-shadow 100ms,
color 100ms,
translate 100ms;
}
slab-search-field::part(clear-button):hover {
background-color: var(--chalk);
}
/*
The outline is transparent rather than gone, so it still shows in forced
colors, where box shadows don't.
*/
slab-search-field::part(clear-button):focus-visible {
box-shadow: 4px 4px 0 var(--ember);
outline: 2px solid transparent;
translate: -2px -2px;
}
slab-search-field:state(error)::part(clear-button) {
border-color: var(--ember-deep);
}
@media (prefers-reduced-motion: reduce) {
slab-search-field::part(clear-button) {
transition: none;
}
}
tokens.css
:root {
/* Secondary text. 6.8:1 and 6.9:1 on paper. */
--ash: var(--slab-styled-ash, light-dark(#5e5a55, #a8a19a));
--border: 2px solid var(--ink);
/* Behind disabled and read-only controls, and hovered rows. */
--chalk: var(--slab-styled-chalk, light-dark(#f4f1ec, #2b2926));
/*
The logo's orange, brighter in the dark. 4.25:1 and 5.2:1 on paper is
enough for borders, fills and large text, but not always for small text,
which takes "--ember-deep".
*/
--ember: var(--slab-styled-ember, light-dark(#d9492a, #ec5f3b));
/*
Orange for small text on paper, and for paper text on it. 5.7:1 and
7.4:1.
*/
--ember-deep: var(--slab-styled-ember-deep, light-dark(#b3381a, #ff8566));
--font-body: var(
--slab-styled-font-body,
'IBM Plex Sans',
system-ui,
sans-serif
);
--font-display: var(
--slab-styled-font-display,
'Zilla Slab',
rockwell,
'Roboto Slab',
serif
);
--font-mono: var(
--slab-styled-font-mono,
'IBM Plex Mono',
ui-monospace,
monospace
);
--ink: var(--slab-styled-ink, light-dark(#1c1c1c, #f4f1ec));
--paper: var(--slab-styled-paper, light-dark(#fff, #1a1918));
/* The hard, offset shadow a raised surface casts. */
--shadow: 4px 4px 0 var(--ink);
}
/*
Forced colors, such as Windows' contrast themes, replace every color that
isn't a system color, so ember fills and paper marks all become the same
background, and a checked Checkbox looks like an unchecked one. The palette
becomes the user's system colors instead, which are kept. Ember is the
highlight, the color of what's selected, and ember-deep, being for text and
for paper text on it, is the text color.
*/
@media (forced-colors: active) {
:host {
--ash: GrayText;
--chalk: Canvas;
--ember: Highlight;
--ember-deep: CanvasText;
--ink: CanvasText;
--paper: Canvas;
}
}