Switch

Description

A binary toggle built on a native checkbox with role="switch", paired with its label in a horizontal field.

bc_switch(
  id,
  label,
  ...,
  size = "default",
  checked = FALSE,
  disabled = FALSE,
  invalid = FALSE,
  description = NULL,
  name = id
)

Argument	Description
`id`	String. The input `id`, and the `for` of its label.
`label`	String or tag. The label content.
`...`	Tag attributes for the `<input>`.
`size`	String. One of `default` or `sm`. `sm` writes `data-size="sm"`.
`checked`	Bool. Whether the box starts ticked.
`disabled`	Bool. Whether the box is disabled.
`invalid`	Bool. Whether to show the invalid state.
`description`	String or tag. Helper text shown under the label, wired to the input with `aria-describedby`.
`name`	String. The input `name`, defaulting to `id`.

A <div> tag.

bc_switch("airplane-mode", "Airplane Mode")

Airplane Mode


bc_switch(
  "focus-mode",
  "Share across devices",
  checked = TRUE,
  description = "Focus is shared across devices."
)

Share across devices

Focus is shared across devices.