Form
Radio Group
A set of Radios with one label, one value, and exactly one checked.
- Element
<slab-radio-group>- Built on
[role=radiogroup]- As Markdown
- radio-group.md
Example
Here's a styled version, <slab-styled-radio-group>. 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.
Sidewalks and patios.
House foundations.
Heavy loads and cold climates.
<slab-styled-radio-group label="Mix strength">
<slab-styled-radio-group-radio label="3,000 psi" value="3000">
<div><strong>3,000 psi</strong><br />Sidewalks and patios.</div>
</slab-styled-radio-group-radio>
<slab-styled-radio-group-radio label="4,000 psi" value="4000" checked>
<div><strong>4,000 psi</strong><br />House foundations.</div>
</slab-styled-radio-group-radio>
<slab-styled-radio-group-radio label="5,000 psi" value="5000">
<div><strong>5,000 psi</strong><br />Heavy loads and cold climates.</div>
</slab-styled-radio-group-radio>
</slab-styled-radio-group>
Sidewalks and patios.
House foundations.
Heavy loads and cold climates.
<slab-radio-group label="Mix strength">
<slab-radio-group-radio label="3,000 psi" value="3000">
<div><strong>3,000 psi</strong><br />Sidewalks and patios.</div>
</slab-radio-group-radio>
<slab-radio-group-radio label="4,000 psi" value="4000" checked>
<div><strong>4,000 psi</strong><br />House foundations.</div>
</slab-radio-group-radio>
<slab-radio-group-radio label="5,000 psi" value="5000">
<div><strong>5,000 psi</strong><br />Heavy loads and cold climates.</div>
</slab-radio-group-radio>
</slab-radio-group>
Usage
pnpm add slab-elements lit
<script type="module">
import 'slab-elements/radio-group.js';
import 'slab-elements/radio-group.radio.js';
</script>
<slab-radio-group label="Delivery" name="delivery">
<slab-radio-group-radio label="Standard" value="standard" checked>Standard</slab-radio-group-radio>
<slab-radio-group-radio label="Express" value="express">Express</slab-radio-group-radio>
</slab-radio-group>
Keyboard
| Key | What it does |
|---|---|
| Tab | Moves into the group at the checked Radio, or the first, and out again. |
| Up, Down, Left, Right | Moves to the previous or next Radio and checks it, wrapping and skipping disabled ones. |
| Space | Checks the focused Radio. |
| Enter | Submits the form, as on a native radio. |
Behavior
<slab-radio-group>
A group of Radios with no visual styles, with one label, one value, and one validity for all of them.
Radios are found by class rather than by tag name, so your subclass of Radio can be named anything. The group does what native radios do for each other: exactly one is checked, exactly one is tabbable, and the arrow keys move between them, wrapping at each end and skipping disabled ones.
Style it through its parts and through :state(disabled), :state(error), and :state(required). How the Radios are arranged is layout, so it's left to the styles around them.
<slab-radio-group-radio>
A Radio with no visual styles. The host is the radio, so style it directly.
There's no native radio inside it. Native radios only group when they share a tree and a name, and each of these is in its own shadow root, so the group does the grouping: it moves focus, checks one at a time, and owns the value.
Radio Group sets its :state(checked) and :state(disabled).
API
<slab-radio-group>
| Name | Type | Default | Description |
|---|---|---|---|
label
Required
|
string |
||
disabled
|
boolean |
false |
|
hide-label
|
boolean |
false |
|
name
|
string |
'' |
|
required
|
boolean |
false |
|
value
|
string |
'' |
The value of the checked and enabled Radio. Not reflected, to match a native control. |
version
|
string |
| Name | Type | Description |
|---|---|---|
form
Read-only
|
HTMLFormElement | null |
|
validity
Read-only
|
ValidityState |
| Signature | Description |
|---|---|
checkValidity(): boolean
|
|
focus(options?: FocusOptions): void
|
|
reportValidity(): boolean
|
|
resetValidityFeedback(): void
|
Clears the validity feedback without changing validity. |
setCustomValidity(message: string): void
|
|
setValidity(flags?: ValidityStateFlags, message?: string): void
|
| Name | Type | Description |
|---|---|---|
(default)
|
Radio |
|
description
|
Element | string |
| Name | Description |
|---|---|
description
|
Text about the group, and its validity message when it has one |
label
|
The label |
radios
|
The Radios |
validity-message
|
<slab-radio-group-radio>
| Name | Type | Default | Description |
|---|---|---|---|
label
Required
|
string |
||
checked
|
boolean |
false |
Like a native radio, the attribute is the default state and the property is the current one. Style :state(checked) rather than [checked]. |
disabled
|
boolean |
false |
|
value
|
string |
'' |
|
version
|
string |
| Name | Type | Description |
|---|---|---|
input
|
Event |
|
change
|
Event |
| Name | Type | Description |
|---|---|---|
(default)
|
Element | string |
The label, plus anything else a design puts in a Radio |
Copy and own it
<slab-styled-radio-group> isn't in the package. It's an example —
copy it into your project and change whatever you want. Under the
hood, it's just the headless element, subclassed, with
styles set. That's it. 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.
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.
radio-group.ts
import { customElement } from 'lit/decorators.js';
import RadioGroup from 'slab-elements/radio-group.js';
import styles from './radio-group.styles.js';
import tokens from './tokens.styles.js';
declare global {
interface HTMLElementTagNameMap {
'slab-styled-radio-group': StyledRadioGroup;
}
}
/**
* Radio Group, styled: its Radios laid in a row of cards, like bricks in a
* course, wrapping when there isn't room.
*/
@customElement('slab-styled-radio-group')
export default class StyledRadioGroup extends RadioGroup {
static override styles = [tokens, styles];
}
radio-group.styles.ts
import { css } from 'lit';
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.5rem;
}
:host(:state(required)) [part~='label']::after {
color: var(--ember-deep);
content: ' *' / '';
}
[part~='radios'] {
display: grid;
gap: 0.75rem;
grid-template-columns: repeat(auto-fit, minmax(10rem, 1fr));
}
/*
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: '■ ' / '';
}
}
`;
radio-group.radio.ts
import { customElement } from 'lit/decorators.js';
import Radio from 'slab-elements/radio-group.radio.js';
import styles from './radio-group.radio.styles.js';
import tokens from './tokens.styles.js';
declare global {
interface HTMLElementTagNameMap {
'slab-styled-radio-group-radio': StyledRadio;
}
}
/**
* Radio, styled: a card with a round mark in its corner. Checked, its border
* turns ember and it lifts off the page on a hard shadow.
*/
@customElement('slab-styled-radio-group-radio')
export default class StyledRadio extends Radio {
static override styles = [tokens, styles];
}
radio-group.radio.styles.ts
import { css } from 'lit';
export default css`
:host {
align-items: start;
background-color: var(--paper);
border: var(--border);
cursor: pointer;
display: grid;
gap: 0.75rem;
grid-template-columns: auto 1fr;
padding: 0.875rem 1rem;
transition:
border-color 100ms,
box-shadow 100ms,
translate 100ms;
}
:host(:hover) {
background-color: var(--chalk);
}
:host(:focus-visible) {
outline: 3px solid var(--ember);
outline-offset: 2px;
}
:host(:state(checked)) {
background-color: var(--paper);
border-color: var(--ember);
box-shadow: var(--shadow);
translate: -2px -2px;
}
:host(:state(disabled)) {
border-style: dashed;
box-shadow: none;
color: var(--ash);
cursor: not-allowed;
translate: none;
}
/* The mark. Checked, an ember dot sits inside a ring of paper. */
:host::before {
background-color: var(--paper);
block-size: 1.125rem;
border: var(--border);
border-radius: 50%;
box-sizing: border-box;
content: '';
inline-size: 1.125rem;
margin-block-start: 0.125rem;
}
:host(:state(checked))::before {
background: radial-gradient(
circle,
var(--ember) 0 0.25rem,
var(--paper) 0.3rem
);
border-color: var(--ember);
}
@media (prefers-reduced-motion: reduce) {
:host {
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);
}
`;