chore[DST-68]: unify switch api (#3227)

marigold-ui · Jul 26, 2023 · 54416dc · 54416dc · vercel · Jul 26, 2023
1 parent 8977129
commit 54416dc
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 7 deletions.
diff --git a/.changeset/forty-toes-dress.md b/.changeset/forty-toes-dress.md
@@ -0,0 +1,6 @@
+---
+"@marigold/docs": patch
+"@marigold/components": patch
+---
+
+chore: unify switch api
diff --git a/docs/content/components/switch/switch.mdx b/docs/content/components/switch/switch.mdx
@@ -32,9 +32,9 @@ import { Switch } from '@marigold/components';
       default: 'false',
     },
     {
-      property: 'checked',
+      property: 'selected',
       type: 'boolean',
-      description: 'With this prop you can set the switch checked.',
+      description: 'With this prop you can set the switch selected.',
       default: 'false',
     },
     {
@@ -44,9 +44,9 @@ import { Switch } from '@marigold/components';
       default: '100%',
     },
     {
-      property: 'defaultChecked',
+      property: 'defaultSelected',
       type: 'boolean',
-      description: 'Set the default checked status of the switch.',
+      description: 'Set the default selected status of the switch.',
       default: 'false',
     },
     {

diff --git a/packages/components/src/Switch/Switch.tsx b/packages/components/src/Switch/Switch.tsx
@@ -25,7 +25,7 @@ export type CustomSwitchProps =
 export interface SwitchProps
   extends Omit<AriaSwitchProps, 'isSelected'>,
     Omit<HtmlProps<'input'>, CustomSwitchProps> {
-  checked?: boolean;
+  selected?: boolean;
   variant?: string;
   size?: string;
   width?: string;
@@ -39,7 +39,7 @@ export const Switch = forwardRef<HTMLInputElement, SwitchProps>(
       variant,
       size,
       width = '100%',
-      checked,
+      selected,
       disabled,
       readOnly,
       defaultChecked,
@@ -50,7 +50,7 @@ export const Switch = forwardRef<HTMLInputElement, SwitchProps>(
     const inputRef = useObjectRef(ref);
     // Adjust props to the react-aria API
     const props = {
-      isSelected: checked,
+      isSelected: selected,
       isDisabled: disabled,
       isReadOnly: readOnly,
       defaultSelected: defaultChecked,