Lumeo

Toggle

A two-state button that can be either on or off.

Installation

dotnet add package Lumeo

One-time app setup (AddLumeo(), CSS & JS) is covered in the installation guide.

Usage

@using Lumeo

<Toggle />

When to Use

  • Activate or deactivate a formatting option such as Bold, Italic, or Underline in a toolbar.
  • Represent a binary on/off state that is clearly visible as a pressed/unpressed button.
  • Provide icon-only controls in compact toolbars where a Switch would be too wide.
  • Combine into a ToggleGroup for mutually exclusive selections like text alignment.

Switch between variants to see the visual difference live.

Pressed: False

Pick a size to see the toggle scale live.

Show icon

Show text

Pressed: False

Toggle the icon and text slots independently to compose your toggle content.

Keyboard Interactions

Key Action
SpaceToggles the pressed state.
EnterActivates the toggle.
TabMoves focus to the next focusable element.

API Reference

Toggle

Property Type Default Description
Pressed bool false Whether the toggle is in a pressed/active state. Use with @bind-Pressed for two-way binding.
PressedChanged EventCallback<bool> Callback invoked when the pressed state changes.
Variant ToggleVariant Default Visual style. Values: Default, Outline.
Size ToggleSize Default Size of the toggle button. Values: Default, Sm, Lg.
Disabled bool false When true, prevents interaction and dims the toggle.
ChildContentRenderFragment?nullContent rendered inside the toggle button (icon, text, or both).
AriaLabelstring?nullAccessible label announced by screen readers for icon-only toggles.
  • ToggleGroup — A set of toggles for selecting one or more formatting options.
  • Button — Use when the action is one-shot rather than a persistent on/off state.
  • Switch — A toggle for settings panels where the on/off metaphor is clearer.
  • Checkbox — Use for multi-select form fields or items inside a list.