Add support for Switch component descriptions

badrap · Mar 4, 2025 · b3e27af · b3e27af
1 parent b91823c
commit b3e27af
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/.changeset/metal-drinks-marry.md b/.changeset/metal-drinks-marry.md
@@ -0,0 +1,5 @@
+---
+"@badrap/libapp": patch
+---
+
+Add support for Switch component descriptions
diff --git a/src/ui/experimental/Switch.ts b/src/ui/experimental/Switch.ts
@@ -13,9 +13,12 @@ type SwitchProps = {
   name?: string;
   /**
    * The text label associated with the switch.
-   * Improves usability and accessibility by providing context for the switch.
    */
   label?: string;
+  /**
+   * The text description associated with the switch.
+   */
+  description?: string;
   /**
    * If defined (i.e. not `undefined`), toggling the switch submits the `action`
    * value with client input state to the UI endpoint.