LogoLogo
  • What is UDML?
  • Document structure
    • <components>
    • <imports>
    • <instructions>
    • <meta>
    • <styles>
    • <tokens>
    • <mappings>
    • <screens>
  • Directives
    • ai-hint
    • <data> Directive Specification
    • <interaction> Directive
    • <layer> Directive
    • <repeat> Directive
    • <responsive>
    • selection
    • <tracking> Directive
  • Components
    • Layout
      • <accordion> Component
      • <box> Component
      • <column> Component
      • <divider>
      • <grid> Component
      • <row> Component
    • Navigation
      • <breadcrumbs> Component
      • <pagination> Component
      • <tab> Component
      • <tabs> Component
    • Text & Display
      • <avatar>
      • <heading>
      • <icon>
      • <image>
      • <label>
      • <text>
      • <video>
    • Controls & Input
      • <button>
      • <checkbox>
      • <input> Component
      • <radio>
      • <select>
      • <slider>
      • <stepper>
      • <switch>
      • <textarea>
    • Forms
      • <form> Component
      • <formField> Component
      • <formGroup> Component
    • Data Collections
      • <dataColumn> Component
      • <dataTable> Component
      • <list> Component
      • <timeline> Component
      • <treeView> Component
    • Data Visualization
      • <chart> Component
      • <summary> Component
    • Modals
      • <dialog> Component
      • <modal> Component
      • <popover> Component
      • <toast> Component
      • <tooltip> Component
  • Prompting Guides
    • Prompting AI Developer Tools with UDML
    • Working with UDML in an Existing Codebase
  • Contributing to UDML
Powered by GitBook
On this page
  • The <switch> component is a toggle switch (alternative to checkbox) used to represent binary on/off states.
  • 🛠 Attributes
  • ✅ Allowed Content
  • 💡 Examples
  • 🧩 AI Interpretation Guidelines
Edit on GitHub
  1. Components
  2. Controls & Input

<switch>

The <switch> component is a toggle switch (alternative to checkbox) used to represent binary on/off states.

🛠 Attributes

Attribute
Type
Required
Description

label

string

Yes

Descriptive label

checked

boolean

No

Initial toggle state

bind

string

No

Path to bound state

disabled

boolean

No

Disables interaction

✅ Allowed Content

Self-closing only.

💡 Examples

Notifications toggle

<switch label="Enable notifications" bind="user.notificationsEnabled"/>

🧩 AI Interpretation Guidelines

  • Render using a toggle UI element with clear labels.

  • Map to state hook or form field if bind is present.

  • Ensure accessible labels and state sync.

Previous<stepper>Next<textarea>

Last updated 1 month ago