Artefact UI

Search

Blog

Dokumentation

About

Playground

Bearbeiten

MenüChevron Down

Blog

Dokumentation

About

Playground

Bearbeiten

Checkbox Kontrollkästchen - Docs - Artefact

Checkbox Kontrollkästchen

Forms
Intelligente Auto-Erkennung

Einführung

Die Checkbox-Komponente ist ein Formularsteuerelement, mit dem Benutzer zwischen binären Auswahlen (aktiviert oder deaktiviert) und einem unbestimmten Zustand umschalten können. Vollständig für den Page Builder optimiert, unterstützt die Komponente Standard-Browserverhalten und kann mit Zustandsbedingungen (wie ungültigen und deaktivierten Zuständen) und akzentuierten Design-Themen angepasst werden.


Verwendung

Sie können Checkboxen wie folgt anpassen und strukturieren:

Einfache Checkbox

Eine Standard-Checkbox mit interaktivem Klick-Label für unkomplizierte Benutzeroptionen.

{
  "blockType": "checkbox",
  "label": "Accept Terms and Conditions"
}

Vorab aktivierte Checkbox

Konfigurieren Sie eine Checkbox, die beim erstmaligen Laden der Seite standardmäßig im aktivierten Zustand gerendert wird.

{
  "blockType": "checkbox",
  "label": "Subscribe to our newsletter",
  "checked": true
}

Deaktivierte Checkbox

Verhindern Sie Benutzerinteraktionen mit der Checkbox, während der aktuelle visuelle Zustand erhalten bleibt.

{
  "blockType": "checkbox",
  "label": "Auto-renew subscription (fixed)",
  "checked": true,
  "disabled": true
}

Ungültiger Validierungszustand

Zeigt an, dass ein Checkbox-Feld die Validierung nicht bestanden hat. Beispielsweise das Erzwingen eines Hakens zur Akzeptierung verpflichtender Richtlinienbedingungen. Die Eingabe wird mit Fehlergrenzen unter Verwendung der Standard-Status-Tokens des Design-Systems hervorgehoben.

{
  "blockType": "checkbox",
  "label": "I accept the User Policy Agreement",
  "invalid": true
}

Akzentuierte Checkbox

Färben Sie aktivierte Zustände und Fokus-Marker mit benutzerdefinierten ästhetischen Akzenten aus der Farbpalette des Design-Systems und skalieren Sie die Größe hoch oder runter.

{
  "blockType": "checkbox",
  "label": "Purple Large Checkbox",
  "checked": true,
  "size": "lg",
  "colorPalette": "purple"
}

Eigenschaften

ParameterTypeDefaultDescription
labelString-Die neben dem Checkbox-Steuerelement angezeigte Textbeschreibung. Ein Klick auf das Label schaltet ebenfalls den Checkbox-Zustand um.
checkedBooleanfalseOb die Checkbox anfangs aktiviert ist. (Server-seitig auf defaultChecked gemappt, um freies, unkontrolliertes Klicken ohne Sperren des Eingabezustands zu ermöglichen).
disabledBooleanfalseDeaktiviert Benutzerinteraktionen und visuelle Klick-Reaktionen.
invalidBooleanfalseHebt die Komponente mit roten/ungültigen Rahmen hervor, um einen Validierungsfehler zu kennzeichnen.
sizeSelectmdPasst die Höhe und Breite des Checkbox-Begrenzungsrahmens an. Optionen: sm, md, lg.
colorPaletteSelect-Akzent-Farbthema, das auf den Hintergrund der Checkbox angewendet wird, wenn sie aktiv oder aktiviert ist. Optionen: blue, green, red, purple, orange, amber, cyan, slate.

Architektur-Hinweise

  • Nicht kontrollierte Standard-Haken: Um zu verhindern, dass Checkboxen in statischen, datengetriebenen Vorlagen ohne benutzerdefinierte Inline-Handler einfrieren (und Benutzerklicks blockieren), wird das CMS-Feld checked in unserer Seiten-Registrierung als defaultChecked aufgelöst.
  • Standard-Formular-Reset: Die Komponente integriert sich in Standard-HTML-Formular-Resets. Resets stellen die Checkboxen nahtlos auf ihre ursprünglichen checked-Zustände zurück, die im JSON-Template konfiguriert wurden.
  • Nativ fokustastatur: Fokusindikatoren und Umschalt-Interaktionen (Leertaste-Auslöser) verlassen sich auf Standard-HTML-Eingaben und Browserverhalten. Dies bleibt auf assistierenden Screenreadern hochperformant und zugänglich.