Artefact UI

Search

Blog

Dokumentation

About

Playground

Bearbeiten

MenüChevron Down

Blog

Dokumentation

About

Playground

Bearbeiten

Switch Schalter - Docs - Artefact

Switch Schalter

Forms
Intelligente Auto-Erkennung

Introduction

Ein von iOS inspiriertes binäres Schalterelement zum Umschalten zwischen aktiviert/deaktiviert für eine einzelne unabhängige Einstellung. Häufig in Einstellungsbereichen, Profilpräferenzen oder Abo-Schaltern. Visuell betont es die Ein/Aus-Semantik stärker als eine Standard-Checkbox.

Die Switch-Komponente ist als switch-Block vollständig in den Page Builder integriert, sodass Autoren Label, Hilfetext, Markenakzentfarbe, Größe und Vorauswahl leicht konfigurieren können.


Usage

Diese Beispiele zeigen, wie Redakteure Schalter binden und strukturieren.

1. Standardmäßig aktiver Schalter mit Hilfetext (Line-Variante)

Ein voraktivierter Schalter mit erklärendem Hilfetext. Zeigt die flüssige line-Variante und eine grüne Akzentpalette für den aktiven Zustand.

{
  "type": "switch",
  "label": "Airplane Mode",
  "helperText": "Disable wireless connections",
  "colorPalette": "green",
  "type": "line",
  "size": "md",
  "defaultChecked": true,
  "interactive": true
}

2. Kompakter Schalter standardmäßig aus (Akzent Rot)

Ein aktiver Zustand für destruktive Aktionen sollte Gefahrenakzente wie Rot verwenden. Diese Demo nutzt die kompakte sm-Größe.

{
  "type": "switch",
  "label": "Delete History",
  "helperText": "Permanently erase activity logs",
  "colorPalette": "red",
  "type": "line",
  "size": "sm",
  "defaultChecked": false,
  "interactive": true
}

3. Deaktivierter Schalter mit Inline-Icon

Zeigt kombinierte Interaktionszustände: ein deaktivierter, aber seinen Wert anzeigender Schalter.

{
  "type": "switch",
  "label": "Beta Features",
  "helperText": "Currently locked by admin",
  "disabled": true,
  "defaultChecked": true,
  "interactive": true
}

Props

EigenschaftCMS-FeldtypStandardBeschreibung / unterstützte Optionen
Label-Text (label)string-Beschreibender Titel neben der Schalterbahn.
Hilfetext (helperText)string-Leichte kontextuelle Hinweise unter dem Schalter.
Markenakzentfarbe (colorPalette)select"blue"Visuelle Palette der Bahnfüllung im aktiven Zustand.
• Optionen: blue, green, red, purple, orange, amber, cyan, slate.
Visuelle Variante (variant)select"line"Visueller Stil der Bahn.
• Optionen: "line", "surface", "subtle", "flushed".
Größenstufe (size)select"md"Steuert die Gesamtgröße der Schalterbahn.
• Optionen: "xs", "sm", "md", "lg", "xl".
Vorausgewählt (defaultChecked)booleanfalseBei true startet der Schalter aktiviert.
Deaktiviert (disabled)booleanfalseDeaktiviert Interaktion und dimmt den Schalter.
Interaktiv erzwingen (interactive)booleantrueHydriert den Schalter zum Binden von Tastatur- und Umschaltevents.

Developer Notes & Accessibility

  • Tastaturnavigation: Das Steuerelement unterstützt native Tastaturinteraktion – Fokus und Space oder Enter schalten den Zustand. Der Fokusring folgt unseren Design-Tokens.
  • WAI-ARIA-Konformität: Kompiliert zu semantischen Schaltern (role="switch", aria-checked), sodass Screenreader den exakten Binärzustand ansagen.
  • Hydration Island: Als Advanced-Layout, das Umschaltevents, Fokus-Einfriedung und Barrierefreiheits-Status verwaltet, läuft Switch als Tier-2-bedingte Insel ("interactive": true).