Skip to content

Button ​

Button and button group components with seven variants, six semantic colors, three sizes, icon slots, link mode, and animated border effects.

Variants ​

Seven variants cover the full range of visual emphasis.

Full width

Colors ​

Six semantic colors communicate intent.

Full width

Emphasis ​

emphasis names the semantic role of a button's action so prominence is a deliberate choice, not a styling accident. It follows the four-role model: Normal, Primary, Cancel, Destructive. Each role picks a color/variant default; an explicit color or variant attribute always overrides it, so emphasis is a shortcut, not a lock-in.

Full width
EmphasisRenders asUse for
normaldefault treatment (unchanged)secondary actions with no special weight
primaryaccent fill (solid)the one action most people will choose
cancelneutral ghostdismiss without changing anything
destructiveerror ink, no filled backgrounddeletes or actions that are hard to undo

Destructive uses red text rather than a filled red slab: a filled error button can be mistaken for a primary action. Keep one primary per view. In development, an ore-dialog footer or ore-alert actions row with more than one emphasis="primary" button logs a warning.

Sizes ​

Full width

States ​

Loading ​

Renders a spinner and blocks interaction during async operations.

Full width

Disabled ​

Full width

Icons ​

Use prefix and suffix slots to add icons alongside text. For icon-only buttons, use icon-only with a label attribute: the label is set as aria-label and is required for accessibility.

Full width

Rounded ​

Buttons default to --radius (8px at a 16px root). The rounded attribute selects another radius from the theme scale; use rounded="xl" for the previous 12px shape. Used without a value (or with "full") it produces a pill shape.

Full width

Elevation ​

By default a button sits flat on the page: depth is a hierarchy signal, so it is opt-in. elevation takes the same 0-5 scale as the rest of the system and lifts a button off the surface. Depth is composed, not assigned, so it survives every interactive state: hovering, pressing, and keyboard focus all keep the elevation the button was given.

Full width

Elevation works on the deliberately decoration-free ghost and text variants too, where it is the only depth available to them.

Full width

Full Width ​

Full width

Full Height ​

fullheight fills the button's own container height instead of its size preset's fixed height : useful when the button itself is the whole tappable surface of a space it doesn't otherwise control the size of, such as a swipe-revealed row action in ore-list-item's actions-left/actions-right slots.

Full width

Set href to render a real, focusable <a> internally. The native anchor owns link semantics, keyboard behavior, context menus, and hover previews; the custom-element host remains a styling and property boundary. All variants, sizes, states, and slots behave identically.

Full width

Security

Always set rel="noopener noreferrer" when using target="_blank" to prevent tabnapping.

Animated Border Effects ​

The effect attribute adds an animated border. Both effects pause automatically when the user has prefers-reduced-motion enabled.

Rainbow ​

An Okabe-Ito colorblind-safe color sweep: good for highlighting a primary call-to-action.

Full width

Shine ​

A neon comet that sweeps the border using the button's own color token.

Full width

Button Groups ​

Basic ​

Full width

Vertical ​

Full width

Attached ​

Removes spacing and connects buttons with shared borders. For a single-select toggle bar, add a value to make it a segmented control.

Full width

Segmented Control ​

Give the group a value and each child button a value, and the group becomes a segmented control (the web equivalent of a radio group styled as a button bar): exactly one option is selected, the container takes role="radiogroup", and each button becomes a radio. Arrow keys move and select, Home / End jump to the ends, and the group emits change with the new value. Set label so screen readers announce what the group is for.

Full width

A value that names no usable button falls back to the first selectable option, so the control always has a selection. A button without value inside a segmented group stays a plain action (e.g. a "Reset" button) and is skipped by the selection. Without a value on the group, it stays a plain container with no selection semantics.

A segment may be wrapped in an ore-tooltip — the group finds a button that is a direct child of the group or of a direct ore-tooltip child:

html
<ore-button-group value="copy" label="Copy format">
  <ore-tooltip content="Copy as text" placement="top"><ore-button value="text">Text</ore-button></ore-tooltip>
  <ore-tooltip content="Copy as HTML" placement="top"><ore-button value="html">HTML</ore-button></ore-tooltip>
</ore-button-group>

Listen for the selection:

html
<ore-button-group id="view" attached value="list" label="View mode">
  <ore-button value="list">List</ore-button>
  <ore-button value="grid">Grid</ore-button>
</ore-button-group>

<script type="module">
  import '@vielzeug/refine/button';

  document.getElementById('view').addEventListener('change', (e) => {
    console.log('selected:', e.detail.values[0]); // 'list' | 'grid'
  });
</script>

Attribute Propagation ​

size, variant, and color set on the group apply to all child buttons automatically.

Full width

Full Width ​

Full width

API Reference ​

ore-button Attributes ​

AttributeTypeDefaultDescription
variant'solid' | 'flat' | 'bordered' | 'outline' | 'ghost' | 'text' | 'frost''solid'Visual style; renders solid when omitted
emphasis'normal' | 'primary' | 'cancel' | 'destructive''normal'Semantic role that picks a color/variant default; an explicit one wins
color'primary' | 'secondary' | 'info' | 'success' | 'warning' | 'error'N/ASemantic color; uncolored neutral when omitted
size'sm' | 'md' | 'lg''md'Button size
type'button' | 'submit' | 'reset''button'HTML button type for form association
disabledbooleanfalseDisables the button
loadingbooleanfalseShows spinner; also disables interaction
effect'shine' | 'rainbow'N/AAnimated border effect
icon-onlybooleanfalseSquare aspect ratio, no padding: pair with label
labelstringN/ASets the accessible label: required for icon-only buttons
fullwidthbooleanfalseExpands to full container width
fullheightbooleanfalseExpands to full container height (see List's swipe actions)
rounded'none' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | 'full'N/ABorder radius; omit value or use 'full' for pill shape
elevation0 | 1 | 2 | 3 | 4 | 5N/AResting depth; omitted keeps the button flat (see Elevation)
hrefstringN/ARenders a native, focusable <a> internally
target'_blank' | '_self' | '_parent' | '_top'N/ALink target (requires href)
relstringN/ALink rel attribute (requires href)
valuestringN/AIdentifies this button as one option of a segmented group

ore-button-group Attributes ​

AttributeTypeDefaultDescription
orientation'horizontal' | 'vertical''horizontal'Layout direction
attachedbooleanfalseRemoves spacing and connects buttons with borders
fullwidthbooleanfalseButtons expand equally to fill container
labelstringN/Aaria-label for the group container
valuestringN/AValue of the selected button; enables segmented selection
size'sm' | 'md' | 'lg'N/APropagated to all child buttons
variant'solid' | 'flat' | 'bordered' | 'outline' | 'ghost' | 'text' | 'frost'N/APropagated to all child buttons
color'primary' | 'secondary' | 'info' | 'success' | 'warning' | 'error'N/APropagated to all child buttons

Slots ​

ore-button

SlotDescription
(default)Button label, text, or content
prefixContent before the label
suffixContent after the label

ore-button-group

SlotDescription
(default)Child button elements

Events ​

ore-button fires the native click (MouseEvent) event. No custom events.

ore-button-group fires change when its selection changes (only when it carries a value). Detail: { values: string[], labels: string[], originalEvent?: Event }.

CSS Parts ​

ore-button

PartElement
buttonThe inner <button> or <a> element
loaderThe loading spinner
contentThe text/content wrapper

ore-button-group

PartElement
groupGroup container

CSS Custom Properties ​

ore-button

PropertyDescriptionDefault
--button-bgBackground colorVariant-dependent
--button-colorText colorVariant-dependent
--button-borderBorder widthvar(--border)
--button-border-colorBorder colorVariant-dependent
--button-border-topTop border width (used by attached groups)N/A
--button-border-startInline-start border width (used by attached groups)N/A
--button-radiusBorder radiusvar(--radius)
--button-paddingInner paddingSize-dependent
--button-gapGap between icon and textSize-dependent
--button-font-sizeFont sizeSize-dependent
--button-min-heightMinimum height floor44px touch target
--button-frost-active-bgBackground when hovered/pressed in frost variantVariant-dependent
--button-frost-active-border-colorBorder color when hovered/pressed in frost variantVariant-dependent
--button-selected-bgBackground of a selected segment in a segmented groupColor family base
--button-selected-colorText color of a selected segment in a segmented groupColor family contrast
--button-selected-border-colorBorder color of a selected segment in a segmented groupColor family base
--button-shadowElevated drop shadow (used when elevation is set)var(--_shadow)
--button-shadow-contactTight shadow where the button meets the surfacevar(--shadow-2xs)

ore-button-group

PropertyDescriptionDefault
--group-gapSpacing between buttons (non-attached)var(--size-2)
--group-radiusBorder radius on first/last buttons in attached modevar(--radius)

Accessibility ​

Keyboard: Enter and Space activate the button. Tab moves focus in and out.

Screen readers: The button role and label are announced automatically. aria-disabled is set when disabled; aria-busy when loading.

Icon-only buttons: The label attribute is required: it becomes the aria-label. Without it, screen readers have nothing to announce.

Button groups: The container gets role="group" automatically. Set the label attribute on the group when the purpose isn't clear from the button labels alone (e.g., label="Text alignment").