XiodUI
HomeDocs
OverviewComponentsStyling & CustomizationChangelog

Components

  • Accordion
  • Agent Steps
  • Alert
  • Alert Dialog
  • Aspect Ratio
  • Autocomplete
  • Avatar
  • Badge
  • Breadcrumb
  • Button
  • Button Group
  • Button Split
  • Calendar
  • Card
  • Carousel
  • Checkbox
  • Circular Progress
  • Collapsible
  • Color Picker
  • Combobox
  • Command
  • Context Menu
  • Copy To Clipboard
  • Corner Badge
  • Dashboard Grid
  • Date Picker
  • Dialog
  • Dot Matrix
  • Draggable
    Updated
  • Drawer
  • Empty
  • Field
  • Fieldset
  • File Upload
    Updated
  • Form
  • Frame
  • Gauge
  • Grid
  • Group
  • Input
  • Input Group
  • Input OTP
  • Input Payment
  • Input Phone
    Updated
  • Input Sensitive
  • Kbd
  • Kinetic Click
  • Label
  • List Box
    Updated
  • Loader
  • Marker
  • Menu
  • Menubar
  • Message
  • Meter
  • Morphic Toast
  • Navigation Menu
  • Number Field
  • Option Picker
  • Orb
  • Pagination
  • Popover
  • Preview Card
    Updated
  • Progress
  • Radio
  • Resizable
  • Ruler Picker
  • Scroll Area
  • Scroll Bar
  • Select
  • Separator
  • Sidebar
  • Skeleton
  • Slider
  • Sortable
  • Switch
  • Table
  • Tabs
  • Text
  • Textarea
  • Timeline
  • Toast
  • Toggle
  • Toggle Group
  • Toolbar
  • Tooltip
  • Waveform
  • Wheel Picker

Loading...

Preview Skeleton

Installation Skeleton

Usage Skeleton

API Reference Skeleton

Sponsors

Support the development of XiodUI and help us build the best component library on Earth.

+++
Sponsor on GitHub

Toggle

Previous: ToastNext: Toggle Group

A button that stays pressed or unpressed.

Preview

Loading Preview...

Installation

bun add xiod-ui

Usage

Imports

1import { Toggle } from "xiod-ui/toggle";

API Reference

Detailed documentation of properties and options.

Toggle

Accepts className, style and render, plus every native attribute of the element it renders.

PropTypeDefaultDescription
defaultPressed
boolean
false

Whether the toggle button is currently pressed. This is the uncontrolled counterpart of pressed.

disabled
boolean
false

Whether the component should ignore user interaction.

nativeButton
boolean
ToastToggle Group
true

Whether the component renders a native <button> element when replacing it via the render prop. Set to false if the rendered element is not a button (for example, <div>).

onPressedChange
((pressed: boolean, eventDetails: Toggle.ChangeEventDetails) => void)
–

Callback fired when the pressed state is changed.

pressed
boolean
–

Whether the toggle button is currently pressed. This is the controlled counterpart of defaultPressed.

size
"lg"|"sm"|"default"
default

The size of the component.

value
string
–

A unique string that identifies the toggle when used inside a toggle group.

variant
"default"|"outline"
default

The visual style of the component.