Askr documentation
Generated API snapshot

@askrjs/themes/switch

Exports from the declarations published in @askrjs/themes. Signatures reflect the published artifact.

Exports

This entrypoint publishes 5 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

Switchtype

Switch: { (props: SwitchButtonProps): JSX.Element; (props: SwitchAsChildProps): JSX.Element; }

Renders the switch part of switch with role="switch". Supports polymorphic rendering via asChild.

SwitchAsChildPropstype

SwitchAsChildProps: SwitchOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<Element>;
  type?: never;
}

Props for the asChild (polymorphic) rendering of Switch.

asChild
asChild: true;
checked
checked?: boolean | undefined;
children
children: JSXElement;
defaultChecked
defaultChecked?: boolean | undefined;
disabled
disabled?: boolean | undefined;
name
name?: string | undefined;
onCheckedChange
onCheckedChange?: ((checked: boolean) => void) | undefined;
ref
ref?: Ref<Element>;
required
required?: boolean | undefined;
type
type?: undefined;
value
value?: string | undefined;

SwitchButtonPropstype

SwitchButtonProps: Omit<JSX.IntrinsicElements['button'], 'children' | 'onClick' | 'type' | 'ref'> & SwitchOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLButtonElement>;
  type?: 'button' | 'submit' | 'reset';
}

Props for Switch Button.

asChild
asChild?: false | undefined;
checked
checked?: boolean | undefined;
children
children?: unknown;
defaultChecked
defaultChecked?: boolean | undefined;
onCheckedChange
onCheckedChange?: ((checked: boolean) => void) | undefined;
ref
ref?: Ref<HTMLButtonElement>;
required
required?: boolean | undefined;
type
type?: "button" | "submit" | "reset" | undefined;

SwitchOwnPropstype

SwitchOwnProps: {
  children?: unknown;
  checked?: boolean;
  defaultChecked?: boolean;
  onCheckedChange?: (checked: boolean) => void;
  disabled?: boolean;
  required?: boolean;
  name?: string;
  value?: string;
}

Own props for Switch, before merging with native element attributes.

checked
checked?: boolean | undefined;
children
children?: unknown;
defaultChecked
defaultChecked?: boolean | undefined;
disabled
disabled?: boolean | undefined;
name
name?: string | undefined;
onCheckedChange
onCheckedChange?: ((checked: boolean) => void) | undefined;
required
required?: boolean | undefined;
value
value?: string | undefined;

SwitchPropstype

SwitchProps: SwitchButtonProps | SwitchAsChildProps

Props for Switch.

asChild
asChild?: boolean | undefined;
checked
checked?: boolean | undefined;
children
children?: unknown;
defaultChecked
defaultChecked?: boolean | undefined;
onCheckedChange
onCheckedChange?: ((checked: boolean) => void) | undefined;
ref
ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLButtonElement | null) => void) | { current: HTMLButtonElement | null; } | null | undefined;
required
required?: boolean | undefined;
type
type?: "button" | "submit" | "reset" | undefined;