Toggle
The quiet key of a toolbar: bold, italic, grid or list, a filter. On is the cap held down in its well, not a light (that's LedKey). ToggleGroup puts Toggles in one long well with arrow-key focus: multiple lets any number be on, without it at most one. For exactly one of a few, always one, use Segmented. Built on Base UI Toggle and ToggleGroup.
Feel A latching key: press it on and the cap goes down and stays down in its well; press it again and it springs back up.
Preview
Or let the agent fetch it: get_component("toggle") on the Echo MCP server.
Installation
First time? Run npx echo-ui-cli init once — it sets the project up, and add refuses to run before it.
At a glance
- Version
- 0.3.0
- Weight
- 843 B · 39.1 KB with what it imports · 1.2 KB of CSS (minified and gzipped; React not counted)
- Needs
- @base-ui/react, size (Echo, brought with it), toolbar (Echo, brought with it)
- Keyboard
- Each Toggle is a button with
aria-pressed; Space and Enter press it. - A ToggleGroup is one tab stop: arrow keys move between its Toggles (following reading direction), Home and End jump to the ends.
- Each Toggle is a button with
- Reduced motion
- The cap goes down and up without travelling.
- Sound
tapas it latches or releases, inside a SoundProvider.
Usage
import { Toggle, ToggleGroup } from "@/echo/toggle";
<Toggle aria-label="Mute" icon={<MuteIcon />} />Composition
Toggle → a cap in a well (Base UI Toggle); ToggleGroup → one well of Toggles (Base UI ToggleGroup)
Examples
Formatting
Any number on at once.
<ToggleGroup aria-label="Text style" multiple>
<Toggle value="bold" aria-label="Bold" icon={<BoldIcon />} />
<Toggle value="italic" aria-label="Italic" icon={<ItalicIcon />} />
</ToggleGroup>One view at a time
At most one; pressing the one that's on turns it off.
<ToggleGroup aria-label="View" defaultValue={["grid"]}>
<Toggle value="grid">Grid</Toggle>
<Toggle value="list">List</Toggle>
</ToggleGroup>On its own
A single latching key.
<Toggle defaultPressed>Loop</Toggle>Accessibility
- Each Toggle is a button with
aria-pressed; Space and Enter press it. - A ToggleGroup is one tab stop: arrow keys move between its Toggles (following reading direction), Home and End jump to the ends.
- On is shown twice over: the cap sits down, and its legend goes from dim to full text. In forced colors, on is a system highlight.
- An icon-only Toggle without aria-label is a type error; so is a ToggleGroup without a name.
Tested against WCAG 2.2 AA on every release:
axe— No axe violations, in the component's own gallery and on its page.keyboard— Every action is reachable and operable from the keyboard alone.focus-visible— Focus is visible on every focusable part, in normal and forced-colors mode.forced-colors— State stays visible when the look's colours are replaced by the system's.target-size— Every target's real hit area is at least 24×24px, at every density.reflow— Content reflows into 320px and survives a doubled text size.
Not covered: screen-reader: not yet verified by a person. Everything above is a machine check; a person has not yet driven this component with a screen reader.
Motion & sound
- Motion tokens
--echo-duration-pop,--echo-ease-pop- Reduced motion
- The cap goes down and up without travelling.
- Sound
tapas it latches or releases, inside a SoundProvider.
Props
| Prop | Type | Default |
|---|---|---|
idThe element's id, so a <label for> or an aria-describedby can reach it. | string | |
nameThe field's name in a form submission, and the key react-hook-form registers. | string | |
disabled | boolean | false |
required | boolean | |
readOnly | boolean | |
autoFocusFocus this control when it mounts. One per page, at most. | boolean | |
onBlurFired on focus loss. react-hook-form validates onTouched and onBlur with it. | function | |
onFocusFired when the control takes focus. | function | |
onKeyDownKeyboard handling you own — Enter to send, Escape to clear. Runs before Echo's. | function | |
childrenToggle: the legend, when it has words. | unknown | |
iconToggle: an icon; icon-only toggles need aria-label (a type error otherwise). | unknown | |
pressedToggle: on (controlled). | boolean | |
defaultPressedToggle: on to begin with. | boolean | |
onPressedChangeToggle: called with the new state. | function | |
valueToggle: its value inside a ToggleGroup. ToggleGroup: the values that are on (string[]). | unknown | |
defaultValueToggleGroup: the values on to begin with. | string[] | |
onValueChangeToggleGroup: called with the values that are on. | function | |
multipleToggleGroup: any number can be on; without it, at most one. | boolean | false |
orientationToggleGroup: which way the arrow keys move. | "horizontal" | "vertical" | "horizontal" |
sizeHeight on the control scale; a group sets it for every Toggle inside. Defaults to the nearest SizeProvider's size. | "sm" | "md" | "lg" | "md" |
aria-labelThe name: required on an icon-only Toggle and on every ToggleGroup (or aria-labelledby). | string | |
aria-labelledby | string |
Anti-patterns
- Never use a Toggle for an action that doesn't stay on: that's a HardwareButton.
- Never put an LED on a Toggle: a row of lit keys breaks the one-accent rule; the latched cap is the state.
- Don't use a single-choice ToggleGroup where one option must always be chosen: that's Segmented.
Changelog
- The drawn device (
echo-ui-core,echo-ui-cli, every component that draws its own material). A seed's newrendersetting ismolded(Echo as it has always been: plastic lit by one key light) ordrawn: the same parts drawn in the ink, the way a spec sheet draws a key. Every part is outlined at one weight (--echo-line,--echo-line-width), hollow on the body; a raised part stands on a hard ink edge as deep as it rises and travels down it when pressed; a recess is an outline drawn inside; something floating stands on a deeper edge. There's no light, so no gloss, no soft shadow and no glow: what a molded device lights (an LED, the rail, a readout, the focus ring, a fader's knob, a radio's pip) is solid ink, and a low-emphasis action is its label underlined. In black and white (the accent the ink) "on" is solid ink and what's drawn on it inverts: a switch's thumb turns paper, a fader's knob is knocked out with a paper ring. The primary key is the paper key that stands highest, on an ink edge twice as deep as a neutral one's, the way a spec sheet draws its CTA. The accent stays the seed's own colour as a flat fill for what's on (a chosen segment, a checked box, a slider's travel, a switch that's on), so an acid highlighter is acid, not the olive a molded device holds it to; what's drawn on it is the ink, or the body when the accent is too deep for the ink. Pressing, travel, sound, what each material is for and every contrast guarantee are unchanged.npx echo-ui-cli style set render drawnturns it on; a style sets it in its seed; the published style and config schemas describe it, andDESIGN.mdsays how a drawn device builds. A molded device renders exactly as before: every line is 0px wide there, and each drawn value a component reads (--echo-drawn-fill,-on-fill,-ink,-rule,-glass,-hollow,-decoration) isinitial, so it falls back to what the component always drew. HardwareButton's bed is the one new hand-tuned shadow: a drawn key stands on its own edge instead of being drawn in a recess. - Every item needs
echo-ui-core0.3.0 (all components). The drawn device, readability past AA and the design tests live in core, and the components that use them are built against it, so each item now declaresecho-ui-core >=0.3.0 <0.4.0. Update core with the items:npm install echo-ui-core@^0.3.0(or your package manager's), thennpx echo-ui-cli update. An item whose files didn't change is the same code under a new version; the 0.2.0 files stay published. - The light device (
echo-ui-core,echo-ui-cli). Echo can be light: a pale chassis makes a device molded in light plastic, like a white calculator or a cream radio, and a dark one makes the device Echo has always been. There's no setting and no mode to switch; the chassis decides (devicePolarity, andvalues.polarityon the theme). On a light device the page is light: its ground, the well, is the body barely set in. Caps get their own ladder, a step lighter than the body with a lit rim that stops short of white, so they keep their bevel; undersides and seams are shaded darker; dim text moves toward the ground by the same step as on a dark device, and reads about 6:1 on it. Screens are paper glass printed in ink, because a glow on a pale body is a smudge. What's lit (an LED, the current rail) is still the accent, held to 3:1 on every ground, so on is brighter than off; the text it prints (a readout, a count, a current tab) and the focus ring are the accent's ink, a step deeper and held to AA, in the newaccent-inkrole. The primary cap is the same cap as a dark device's, the accent with a light label: its label is the newprimary-cap-inkrole, and progress cells, loader dots and a meter's fill, the same plastic, read 3:1 on the page. A neutral cap or a slider that fills with it under its own dark label fills with the newpour-*roles, the accent's pale stops. Shadows are drawn at half their weight, in a deep colour of the body's own hue (--echo-cast-ink) instead of black. Every guarantee holds as it does on a dark device, and the contrast sweep now runs on light bodies too. A dark seed makes exactly the theme it did before, and the new roles equal the ones they stand for there. The components that mixed a recess toward black, painted paper in the text colour or lit a pillow of light with it read the theme's new--echo-shade-ink,--echo-paper-stockand--echo-paper-inkinstead, with the old value as the fallback, and a reflective screen reads--echo-screen-*; the components that print a lit label read--echo-primary-cap-inkand--echo-accent-inkthe same way; every rail is drawn in the glow, and every focus ring, theringrecipes included, in the ink.style usewears a light style now, andstyle checksays which device a style makes. A dark screen tint on a light body is still refused: one text colour can't serve both, and the theme says so. - The rest of the inputs:
Toggle,Toolbar,Meter,RangeSlider, and two instruments,KnobandLevelMeter. PlusstartandendonField. -Toggle/ToggleGroup: the quiet toolbar key. On is the cap held down in its well, not a light; a group shares one well, with arrow keys between its keys,multipleor at most one. -Toolbar/ButtonGroup: caps sharing one long well. A Toolbar is one tab stop with the arrow keys, Home and End along it, andsmcontrols; Toggles and ToggleGroups inside join its order by themselves. A ButtonGroup is the look alone. -Fieldstart/end: a search icon or a currency sign engraved into the well before the text; a unit or a small key (clear, show password) after it. -Meter: a measurement in a range (storage, battery), a tube of lit plastic that settles to its level with a small slosh;marksengrave a limit without a second colour. -RangeSlider: two of Slider's knobs on one rail for a span, named "…, minimum" and "…, maximum"; they never cross. -Knob: a rotary cap with a lit scale. Drag it, wheel it once focused, or use the slider keys; it clicks at each step and settles onto each detent on a spring. -LevelMeter: a live level as LED cells with real ballistics and a held peak. It draws without re-rendering, stops once it's still, and tells a screen reader its level at most once a second. - Components whose shadow is a recipe read it by name. 71 shadows in 54 items now say
var(--echo-shadow-<name>, <the same shadow>), so they look exactly as they did (every docs page was compared before and after) and follow a theme's recipes. Scope declares the recipes that read the accent again, so a Scope's own colour still reaches its focus rings and glows, and reflective screens do the same for theirs. Shadows that move with their part (a cap's drop as it's pressed) stay in the component. - Comments only, no behaviour change. Comments in the component source used to cite documents, milestones and ticket numbers from Echo's own planning, none of which exist in your project. The citations are gone and the sentences around them stay. Where a comment was only a citation, it now says what it meant. Three development warnings (
HardwareButton'sengraved/captionchecks andStatusDot's missing-label check) also dropped the ticket code at the end of the message.echo-ui diffwill show changes in most items; none of them are to code. - An item's version is now a function of declared data, not of how the changelog is formatted. The version an item ships under is published once and never rewritten, and it used to be inferred from prose: a regex for a bolded "Breaking" run across the whole unreleased section, and attribution by "does a bullet mention this name in backticks". One breaking entry therefore moved every item that changed that cycle, and an entry explaining that "
MenuandSheetare unchanged here" filed itself as a change to Menu and Sheet — which it really had. - The agent brief says Echo has not shipped.
llms.txtand the MCP server's instructions led withnpx echo-ui-cli init, and that name on npm is a reserved stub with no executable — so a model following the brief wrote an install step that fails with npx's own error. The brief now opens with the caveat, and the docs carry it on every surface that shows a command. One switch (CLI_RELEASED) silences all of them at launch, and a test refuses to let one move without the others. Affectsall componentsonly in what the brief says about installing them; no item's props, CSS or rendered semantics change. - Echo's home is
echo-ui.com. The registry, the docs and the packages all move to it fromecho.nawwara.studio. Nothing was published under the old host, so noecho.jsonanywhere points at it and there is nothing to migrate — this is the last release where that is true. - Weights, line heights, letter-spacing, z-index, border widths and icon sizes come from the theme scales in
all components, with the old value as a fallback, so components keep working withecho-ui-core@0.0.1. Strays moved to the nearest step: most by under a pixel; HardwareButton icons are 14/16/20px (were 15/17/19). - Content now reflows into a 320px screen (400% zoom) and survives a doubled browser text size (WCAG 1.4.10, 1.4.4), across
all components.Select's 180px floor,NumberField's readout,SegmentedandStepsas flex items,EmptyState's grid columns, andAvatar's fixed-pixel disc all gave way;Panelcounts its padding inside a width you set (box-sizing: border-box), so a<Panel style={{ width: 220 }}>is now 220px wide overall rather than 260px.