Generated API snapshot

@askrjs/ui

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

Exports

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

`AccordionContent`type

AccordionContent: { (props: AccordionContentProps): JSX.Element | null; (props: AccordionContentAsChildProps): JSX.Element | null; }

Renders the accordion-content part of accordion with role="region". Supports polymorphic rendering via asChild.

`AccordionContentAsChildProps`type

AccordionContentAsChildProps: BoxAsChildProps & AccordionContentOwnProps

Props for the asChild (polymorphic) rendering of Accordion Content.

asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<Element>;

`AccordionContentOwnProps`type

AccordionContentOwnProps: {
  forceMount?: boolean;
}

Own props for Accordion Content, before merging with native element attributes.

forceMount: forceMount?: boolean | undefined;

`AccordionContentProps`type

AccordionContentProps: BoxProps<'div', HTMLDivElement> & AccordionContentOwnProps

Props for Accordion Content.

asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;

`AccordionHeader`type

AccordionHeader: { (props: AccordionHeaderProps): JSX.Element; (props: AccordionHeaderAsChildProps): JSX.Element; }

Renders the accordion-header part of accordion. Supports polymorphic rendering via asChild.

`AccordionHeaderAsChildProps`type

AccordionHeaderAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Accordion Header.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`AccordionHeaderProps`type

AccordionHeaderProps: BoxProps<'h3', HTMLHeadingElement>

Props for Accordion Header.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLHeadingElement>;

`AccordionItem`type

AccordionItem: (props: AccordionItemProps) => JSX.Element

Renders the accordion-item part of accordion.

`AccordionItemOwnProps`type

AccordionItemOwnProps: {
  children?: unknown;
  value: string;
  disabled?: boolean;
}

Own props for Accordion Item, before merging with native element attributes.

children: children?: unknown;
disabled: disabled?: boolean | undefined;
value: value: string;

`AccordionItemProps`type

AccordionItemProps: BoxProps<'div', HTMLDivElement> & AccordionItemOwnProps

Props for Accordion Item.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;
value: value: string;

`AccordionMultipleProps`type

AccordionMultipleProps: BoxProps<'div', HTMLDivElement> & AccordionSharedOwnProps & {
  type: 'multiple';
  value?: string[];
  defaultValue?: string[];
  onValueChange?: (value: string[]) => void;
}

Props for Accordion Multiple.

asChild: asChild?: false | undefined;
children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
collapsible: collapsible?: boolean | undefined;
defaultValue: defaultValue?: string[] | undefined;
id: id?: string | undefined;
loop: loop?: boolean | undefined;
onValueChange: onValueChange?: ((value: string[]) => void) | undefined;
orientation: orientation?: AccordionOrientation | undefined;
ref: ref?: Ref<HTMLDivElement>;
type: type: "multiple";
value: value?: string[] | undefined;

`AccordionProps`type

AccordionProps: AccordionSingleProps | AccordionMultipleProps

Props for Accordion.

asChild: asChild?: false | undefined;
children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
collapsible: collapsible?: boolean | undefined;
defaultValue: defaultValue?: string | string[] | undefined;
id: id?: string | undefined;
loop: loop?: boolean | undefined;
onValueChange: onValueChange?: ((value: string[]) => void) | ((value: string) => void) | undefined;
orientation: orientation?: AccordionOrientation | undefined;
ref: ref?: Ref<HTMLDivElement>;
type: type?: "single" | "multiple" | undefined;
value: value?: string | string[] | undefined;

`AccordionSingleProps`type

AccordionSingleProps: BoxProps<'div', HTMLDivElement> & AccordionSharedOwnProps & {
  type?: 'single';
  value?: string;
  defaultValue?: string;
  onValueChange?: (value: string) => void;
}

Props for Accordion Single.

asChild: asChild?: false | undefined;
children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
collapsible: collapsible?: boolean | undefined;
defaultValue: defaultValue?: string | undefined;
id: id?: string | undefined;
loop: loop?: boolean | undefined;
onValueChange: onValueChange?: ((value: string) => void) | undefined;
orientation: orientation?: AccordionOrientation | undefined;
ref: ref?: Ref<HTMLDivElement>;
type: type?: "single" | undefined;
value: value?: string | undefined;

`AccordionTrigger`type

AccordionTrigger: { (props: AccordionTriggerProps): JSX.Element; (props: AccordionTriggerAsChildProps): JSX.Element; }

Renders the accordion-trigger part of accordion. Supports polymorphic rendering via asChild.

`AccordionTriggerAsChildProps`type

AccordionTriggerAsChildProps: ButtonLikeAsChildProps

Props for the asChild (polymorphic) rendering of Accordion Trigger.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`AccordionTriggerProps`type

AccordionTriggerProps: ButtonLikeProps<'button', HTMLButtonElement>

Props for Accordion Trigger.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`AlertDialogAction`type

DialogClose: { (props: DialogCloseProps): JSX.Element; (props: DialogCloseAsChildProps): JSX.Element; }

Renders the dialog-close part of dialog. Supports polymorphic rendering via asChild.

`AlertDialogActionAsChildProps`type

AlertDialogActionAsChildProps: DialogCloseAsChildProps

Props for the asChild (polymorphic) rendering of Alert Dialog Action.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`AlertDialogActionProps`type

AlertDialogActionProps: DialogCloseProps

Props for Alert Dialog Action.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`AlertDialogCancel`type

DialogClose: { (props: DialogCloseProps): JSX.Element; (props: DialogCloseAsChildProps): JSX.Element; }

Renders the dialog-close part of dialog. Supports polymorphic rendering via asChild.

`AlertDialogCancelAsChildProps`type

AlertDialogCancelAsChildProps: DialogCloseAsChildProps

Props for the asChild (polymorphic) rendering of Alert Dialog Cancel.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`AlertDialogCancelProps`type

AlertDialogCancelProps: DialogCloseProps

Props for Alert Dialog Cancel.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`AlertDialogContent`type

AlertDialogContent: (props: AlertDialogContentProps | AlertDialogContentAsChildProps) => JSX.Element

Renders a part of alert-dialog. Supports polymorphic rendering via asChild.

`AlertDialogContentAsChildProps`type

AlertDialogContentAsChildProps: DialogContentAsChildProps

Props for the asChild (polymorphic) rendering of Alert Dialog Content.

asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
onDismiss: onDismiss?: (() => void) | undefined;
onEscapeKeyDown: onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside: onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside: onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;
ref: ref?: Ref<Element>;
restoreFocus: Explicit focus target used when a controlled dialog has no persistent trigger.
role: role?: "dialog" | "alertdialog" | undefined;

`AlertDialogContentOwnProps`type

AlertDialogContentOwnProps: DialogContentOwnProps

Own props for Alert Dialog Content, before merging with native element attributes.

forceMount: forceMount?: boolean | undefined;
onDismiss: onDismiss?: (() => void) | undefined;
onEscapeKeyDown: onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside: onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside: onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;
restoreFocus: Explicit focus target used when a controlled dialog has no persistent trigger.
role: role?: "dialog" | "alertdialog" | undefined;

`AlertDialogContentProps`type

AlertDialogContentProps: DialogContentProps

Props for Alert Dialog Content.

asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
onDismiss: onDismiss?: (() => void) | undefined;
onEscapeKeyDown: onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside: onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside: onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;
ref: ref?: Ref<HTMLDivElement>;
restoreFocus: Explicit focus target used when a controlled dialog has no persistent trigger.
role: role?: "dialog" | "alertdialog" | undefined;

`AlertDialogDescription`type

DialogDescription: { (props: DialogDescriptionProps): JSX.Element; (props: DialogDescriptionAsChildProps): JSX.Element; }

Renders the dialog-description part of dialog. Supports polymorphic rendering via asChild.

`AlertDialogDescriptionAsChildProps`type

AlertDialogDescriptionAsChildProps: DialogDescriptionAsChildProps

Props for the asChild (polymorphic) rendering of Alert Dialog Description.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`AlertDialogDescriptionProps`type

AlertDialogDescriptionProps: DialogDescriptionProps

Props for Alert Dialog Description.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLParagraphElement>;

`AlertDialogOverlay`type

DialogOverlay: { (props: DialogOverlayProps): JSX.Element | null; (props: DialogOverlayAsChildProps): JSX.Element | null; }

Renders the dialog-overlay part of dialog. With @askrjs/themes/default, the overlay is fully styled out of the box with the shared backdrop token, blur, stacking, and fade animation. Standard Dialog and AlertDialog usage requires no additional overlay CSS; customize the theme tokens instead of applying a competing background class. Supports polymorphic rendering via asChild.

`AlertDialogOverlayAsChildProps`type

AlertDialogOverlayAsChildProps: DialogOverlayAsChildProps

Props for the asChild (polymorphic) rendering of Alert Dialog Overlay.

asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<Element>;

`AlertDialogOverlayOwnProps`type

AlertDialogOverlayOwnProps: DialogOverlayOwnProps

Own props for Alert Dialog Overlay, before merging with native element attributes.

forceMount: forceMount?: boolean | undefined;

`AlertDialogOverlayProps`type

AlertDialogOverlayProps: DialogOverlayProps

Props for Alert Dialog Overlay.

asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;

`AlertDialogOwnProps`type

AlertDialogOwnProps: DialogProps

Own props for Alert Dialog, before merging with native element attributes.

children: children?: unknown;
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
modal: modal?: boolean | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;

`AlertDialogPortal`type

DialogPortal: (props: DialogPortalProps) => JSX.Element | null

Renders a part of dialog.

`AlertDialogPortalProps`type

AlertDialogPortalProps: DialogPortalProps

Props for Alert Dialog Portal.

children: children?: unknown;

`AlertDialogProps`type

AlertDialogProps: DialogProps

Props for Alert Dialog.

children: children?: unknown;
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
modal: modal?: boolean | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;

`AlertDialogTitle`type

DialogTitle: { (props: DialogTitleProps): JSX.Element; (props: DialogTitleAsChildProps): JSX.Element; }

Renders the dialog-title part of dialog. Supports polymorphic rendering via asChild.

`AlertDialogTitleAsChildProps`type

AlertDialogTitleAsChildProps: DialogTitleAsChildProps

Props for the asChild (polymorphic) rendering of Alert Dialog Title.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`AlertDialogTitleProps`type

AlertDialogTitleProps: DialogTitleProps

Props for Alert Dialog Title.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLHeadingElement>;

`AlertDialogTrigger`type

AlertDialogTrigger: (props: AlertDialogTriggerProps | AlertDialogTriggerAsChildProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders a part of alert-dialog. Supports polymorphic rendering via asChild.

`AlertDialogTriggerAsChildProps`type

AlertDialogTriggerAsChildProps: DialogTriggerAsChildProps

Props for the asChild (polymorphic) rendering of Alert Dialog Trigger.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`AlertDialogTriggerProps`type

AlertDialogTriggerProps: DialogTriggerProps

Props for Alert Dialog Trigger.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`Avatar`type

Avatar: { (props: AvatarProps): JSX.Element; (props: AvatarAsChildProps): JSX.Element; }

Renders the avatar part of avatar. Supports polymorphic rendering via asChild.

`AvatarAsChildProps`type

AvatarAsChildProps: BoxAsChildProps & AvatarOwnProps

Props for the asChild (polymorphic) rendering of Avatar.

asChild: asChild: true;
children: children: JSXElement;
id: id?: string | undefined;
ref: ref?: Ref<Element>;

`AvatarFallback`type

AvatarFallback: { (props: AvatarFallbackProps): JSX.Element | null; (props: AvatarFallbackAsChildProps): JSX.Element | null; }

Renders the avatar-fallback part of avatar. Supports polymorphic rendering via asChild.

`AvatarFallbackAsChildProps`type

AvatarFallbackAsChildProps: BoxAsChildProps & AvatarFallbackOwnProps

Props for the asChild (polymorphic) rendering of Avatar Fallback.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`AvatarFallbackOwnProps`type

AvatarFallbackOwnProps: {
  children?: unknown;
}

Own props for Avatar Fallback, before merging with native element attributes.

children: children?: unknown;

`AvatarFallbackProps`type

AvatarFallbackProps: BoxProps<'span', HTMLSpanElement> & AvatarFallbackOwnProps

Props for Avatar Fallback.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLSpanElement>;

`AvatarImage`type

AvatarImage: (props: AvatarImageProps) => JSX.Element

Renders the avatar-image part of avatar.

`AvatarImageOwnProps`type

AvatarImageOwnProps: {
  src?: string;
  alt: string;
  onLoadingStatusChange?: (status: AvatarLoadingStatus) => void;
}

Own props for Avatar Image, before merging with native element attributes.

alt: alt: string;
onLoadingStatusChange: onLoadingStatusChange?: ((status: AvatarLoadingStatus) => void) | undefined;
src: src?: string | undefined;

`AvatarImageProps`type

AvatarImageProps: Omit<JSX.IntrinsicElements['img'], 'children' | 'ref' | 'onLoad' | 'onError' | 'alt' | 'src'> & AvatarImageOwnProps & {
  ref?: Ref<HTMLImageElement>;
}

Props for Avatar Image.

alt: alt: string;
onLoadingStatusChange: onLoadingStatusChange?: ((status: AvatarLoadingStatus) => void) | undefined;
ref: ref?: Ref<HTMLImageElement>;
src: src?: string | undefined;

`AvatarLoadingStatus`type

AvatarLoadingStatus: 'idle' | 'loading' | 'loaded' | 'error'

Avatar Loading Status.

`AvatarOwnProps`type

AvatarOwnProps: {
  children?: unknown;
  id?: string;
}

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

children: children?: unknown;
id: id?: string | undefined;

`AvatarProps`type

AvatarProps: BoxProps<'span', HTMLSpanElement> & AvatarOwnProps

Props for Avatar.

asChild: asChild?: false | undefined;
children: children?: unknown;
id: id?: string | undefined;
ref: ref?: Ref<HTMLSpanElement>;

`Button`type

Button: { (props: ButtonNativeProps): JSX.Element; (props: ButtonAsChildProps): JSX.Element; }

Headless Button component ## Responsibilities - Compose pressable foundation for interaction behavior - Enforce type="button" default to prevent accidental form submission - Forward props and refs to native button or child element ## Non-Responsibilities (delegated to pressable foundation) - Keyboard event handling (Enter/Space) - Pointer event handling - Disabled state enforcement - ARIA attribute application ## Invariants - MUST NOT contain any event handler logic - MUST NOT check disabled prop directly - MUST use pressable() for ALL interaction behavior - MUST use mergeProps() for ALL prop composition Renders the button part of button. Supports polymorphic rendering via asChild.

Native button (prevents accidental submit)
```tsx
<Button onPress={handleSave}>Save</Button>
```

Explicit form submission
```tsx
<Button type="submit" onPress={handleSubmit}>Submit</Button>
```

Polymorphic rendering (asChild)
```tsx
<Button asChild onPress={handleNav}>
<a href="/home">Home</a>
</Button>
```

`ButtonAsChildElement`type

ButtonAsChildElement: JSXElement | JSX.Element

Button As Child Element.

`ButtonAsChildProps`type

ButtonAsChildProps: ButtonOwnProps & {
  asChild: true;
  children: ButtonAsChildElement;
  ref?: Ref<Element>;
  type?: never;
}

Props when rendering with asChild (polymorphic)

asChild: asChild: true;
children: children: ButtonAsChildElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((e: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
size: size?: ButtonSize | undefined;
type: type?: undefined;
variant: variant?: ButtonVariant | undefined;
width: width?: ButtonWidth | undefined;

`ButtonNativeProps`type

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

Props when rendering as native <button>

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((e: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
size: size?: ButtonSize | undefined;
type: type?: "button" | "submit" | "reset" | undefined;
variant: variant?: ButtonVariant | undefined;
width: width?: ButtonWidth | undefined;

`ButtonOwnProps`type

ButtonOwnProps: {
  children?: unknown;
  onPress?: (e: PressEvent) => void;
  disabled?: boolean;
  variant?: ButtonVariant;
  size?: ButtonSize;
  width?: ButtonWidth;
}

Core Button props shared across all variants

children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((e: PressEvent) => void) | undefined;
size: size?: ButtonSize | undefined;
variant: variant?: ButtonVariant | undefined;
width: width?: ButtonWidth | undefined;

`ButtonProps`type

ButtonProps: ButtonNativeProps | ButtonAsChildProps

Union of all Button prop variants

asChild: asChild?: boolean | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((e: PressEvent) => void) | undefined;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLButtonElement | null) => void) | { current: HTMLButtonElement | null; } | null | undefined;
size: size?: ButtonSize | undefined;
type: type?: "button" | "submit" | "reset" | undefined;
variant: variant?: ButtonVariant | undefined;
width: width?: ButtonWidth | undefined;

`ButtonSize`type

ButtonSize: 'xs' | 'sm' | 'md' | 'lg' | 'icon' | 'icon-xs' | 'icon-sm' | 'icon-lg'

Button Size.

`ButtonVariant`type

ButtonVariant: 'default' | 'primary' | 'secondary' | 'outline' | 'ghost' | 'destructive' | 'link'

Button Variant.

`ButtonWidth`type

ButtonWidth: 'auto' | 'full'

Button Width.

`Checkbox`type

Checkbox: { (props: CheckboxInputProps): JSX.Element; (props: CheckboxAsChildProps): JSX.Element; }

Headless Checkbox component ## Responsibilities - Apply aria-checked for checkbox state signaling - Handle indeterminate state for native and asChild hosts - Support controlled and uncontrolled checked state - Forward props and refs to native input or child element - Preserve native checkbox semantics and apply checkbox behavior to asChild hosts ## Non-Responsibilities - Form submission orchestration beyond native input props ## Invariants - MUST NOT add role="button" (native inputs are role="checkbox") - checked state may be controlled or uncontrolled - indeterminate overrides checked for state signaling - For asChild, consumer MUST provide role="checkbox" Renders the checkbox part of checkbox with role="checkbox". Supports polymorphic rendering via asChild.

Native checkbox input
```tsx
const checked = state(false);
<Checkbox checked={checked()} onPress={() => checked.set(!checked())} />
```

Polymorphic rendering (asChild)
```tsx
<Checkbox asChild checked={agreed} onPress={toggleAgree}>
<div role="checkbox">I agree to terms</div>
</Checkbox>
```

Indeterminate state (partial selection)
```tsx
<Checkbox checked={someChecked} indeterminate={!allChecked && someChecked} onPress={toggleAll}>
Select All
</Checkbox>
```

`CheckboxAsChildProps`type

CheckboxAsChildProps: CheckboxOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<Element>;
}

Props when rendering via asChild

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

`CheckboxInputProps`type

CheckboxInputProps: Omit<JSX.IntrinsicElements['input'], 'children' | 'onClick' | 'disabled' | 'type' | 'ref' | 'checked' | 'name' | 'value' | 'required'> & CheckboxOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLInputElement>;
}

Props when rendering as a native <input type="checkbox"> element

asChild: asChild?: false | undefined;
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;
onPress: onPress?: ((e: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLInputElement>;
required: required?: boolean | undefined;
value: value?: string | undefined;

`CheckboxOwnProps`type

CheckboxOwnProps: {
  children?: unknown;
  onPress?: (e: PressEvent) => void;
  checked?: boolean;
  defaultChecked?: boolean;
  onCheckedChange?: (checked: boolean) => void;
  indeterminate?: boolean;
  disabled?: boolean;
  required?: boolean;
  name?: string;
  value?: string;
}

Props shared by all Checkbox variants

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

`CheckboxProps`type

CheckboxProps: CheckboxInputProps | CheckboxAsChildProps

Discriminated union of Checkbox prop types

asChild: asChild?: boolean | undefined;
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;
onPress: onPress?: ((e: PressEvent) => void) | undefined;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLInputElement | null) => void) | { current: HTMLInputElement | null; } | null | undefined;
required: required?: boolean | undefined;
value: value?: string | undefined;

`Collapsible`type

Collapsible: (props: CollapsibleProps) => JSX.Element

Renders a part of collapsible.

`CollapsibleContent`type

CollapsibleContent: { (props: CollapsibleContentProps): JSX.Element | null; (props: CollapsibleContentAsChildProps): JSX.Element | null; }

Renders the collapsible-content part of collapsible. Supports polymorphic rendering via asChild.

`CollapsibleContentAsChildProps`type

CollapsibleContentAsChildProps: any

Props for the asChild (polymorphic) rendering of Collapsible Content.

asChild: Render as child element instead of div
children: Child content
forceMount: Force mount even when closed (for animation)
ref: Ref forwarding

`CollapsibleContentProps`type

CollapsibleContentProps: any

Content component props

asChild: Render as child element instead of div
children: Child content
forceMount: Force mount even when closed (for animation)
ref: Ref forwarding

`CollapsibleProps`type

CollapsibleProps: any

Root component props

children: Child components (Trigger, Content)
defaultOpen: Uncontrolled default open state
disabled: Whether the collapsible is disabled
id: Stable caller-provided identity used for ARIA linking when available
onOpenChange: Callback when open state changes
open: Controlled open state

`CollapsibleTrigger`type

CollapsibleTrigger: { (props: CollapsibleTriggerProps): JSX.Element; (props: CollapsibleTriggerAsChildProps): JSX.Element; }

Renders the collapsible-trigger part of collapsible. Supports polymorphic rendering via asChild.

`CollapsibleTriggerAsChildProps`type

CollapsibleTriggerAsChildProps: any

Props for the asChild (polymorphic) rendering of Collapsible Trigger.

asChild: Render as child element instead of button
children: Child content
ref: Ref forwarding

`CollapsibleTriggerProps`type

CollapsibleTriggerProps: any

Trigger component props (button semantics)

asChild: Render as child element instead of button
children: Child content
ref: Ref forwarding

`DebouncedInput`type

DebouncedInput: (props: DebouncedInputProps) => JSX.Element

DebouncedInput is a convenience wrapper around Input that emits a settled value for search and filter surfaces. One component-owned timer is re-timed when debounceMs changes (or emits at once when the delay drops to zero). A pending value is delivered to the latest onDebouncedInput, is dropped when onDebouncedInput is removed, and is cancelled on unmount.

`DebouncedInputProps`type

DebouncedInputProps: Omit<InputInputProps, 'onInput' | 'type'> & {
  type?: JSX.IntrinsicElements['input']['type'];
  debounceMs?: number;
  onInput?: (event: InputEvent) => void;
  onDebouncedInput?: (value: string) => void;
}

Props for Debounced Input.

asChild: asChild?: false | undefined;
children: children?: unknown;
debounceMs: debounceMs?: number | undefined;
onDebouncedInput: onDebouncedInput?: ((value: string) => void) | undefined;
onInput: onInput?: ((event: InputEvent) => void) | undefined;
ref: ref?: Ref<HTMLInputElement>;
type: type?: ReactiveProp<IntrinsicTextValue>;

`Dialog`type

Dialog: (props: DialogProps) => JSX.Element

Coordinates the Dialog trigger, portal, overlay, and content.

```tsx
<Dialog>
  <DialogTrigger>Open dialog</DialogTrigger>
  <DialogPortal>
    <DialogOverlay />
    <DialogContent>Confirm action</DialogContent>
  </DialogPortal>
</Dialog>
```

`DialogClose`type

DialogClose: { (props: DialogCloseProps): JSX.Element; (props: DialogCloseAsChildProps): JSX.Element; }

Renders the dialog-close part of dialog. Supports polymorphic rendering via asChild.

`DialogCloseAsChildProps`type

DialogCloseAsChildProps: ButtonLikeAsChildProps

Props for the asChild (polymorphic) rendering of Dialog Close.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`DialogCloseProps`type

DialogCloseProps: ButtonLikeProps<'button', HTMLButtonElement>

Props for Dialog Close.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`DialogContent`type

DialogContent: { (props: DialogContentProps): JSX.Element | null; (props: DialogContentAsChildProps): JSX.Element | null; }

Renders the dialog-content part of dialog. Supports polymorphic rendering via asChild.

`DialogContentAsChildProps`type

DialogContentAsChildProps: BoxAsChildProps & DialogContentOwnProps

Props for the asChild (polymorphic) rendering of Dialog Content.

asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
onDismiss: onDismiss?: (() => void) | undefined;
onEscapeKeyDown: onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside: onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside: onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;
ref: ref?: Ref<Element>;
restoreFocus: Explicit focus target used when a controlled dialog has no persistent trigger.
role: role?: "dialog" | "alertdialog" | undefined;

`DialogContentOwnProps`type

DialogContentOwnProps: {
  forceMount?: boolean;
  role?: 'dialog' | 'alertdialog';
  onEscapeKeyDown?: (event: KeyboardEvent) => void;
  onPointerDownOutside?: (event: PointerEvent) => void;
  onInteractOutside?: (event: Event) => void;
  onDismiss?: () => void;
  /** Explicit focus target used when a controlled dialog has no persistent trigger. */
  restoreFocus?: HTMLElement | null | (() => HTMLElement | null);
}

Own props for Dialog Content, before merging with native element attributes.

forceMount: forceMount?: boolean | undefined;
onDismiss: onDismiss?: (() => void) | undefined;
onEscapeKeyDown: onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside: onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside: onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;
restoreFocus: Explicit focus target used when a controlled dialog has no persistent trigger.
role: role?: "dialog" | "alertdialog" | undefined;

`DialogContentProps`type

DialogContentProps: BoxProps<'div', HTMLDivElement> & DialogContentOwnProps

Props for Dialog Content.

asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
onDismiss: onDismiss?: (() => void) | undefined;
onEscapeKeyDown: onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside: onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside: onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;
ref: ref?: Ref<HTMLDivElement>;
restoreFocus: Explicit focus target used when a controlled dialog has no persistent trigger.
role: role?: "dialog" | "alertdialog" | undefined;

`DialogDescription`type

DialogDescription: { (props: DialogDescriptionProps): JSX.Element; (props: DialogDescriptionAsChildProps): JSX.Element; }

Renders the dialog-description part of dialog. Supports polymorphic rendering via asChild.

`DialogDescriptionAsChildProps`type

DialogDescriptionAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Dialog Description.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`DialogDescriptionProps`type

DialogDescriptionProps: BoxProps<'p', HTMLParagraphElement>

Props for Dialog Description.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLParagraphElement>;

`DialogOverlay`type

DialogOverlay: { (props: DialogOverlayProps): JSX.Element | null; (props: DialogOverlayAsChildProps): JSX.Element | null; }

`DialogOverlayAsChildProps`type

DialogOverlayAsChildProps: BoxAsChildProps & DialogOverlayOwnProps

Props for the asChild (polymorphic) rendering of Dialog Overlay.

asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<Element>;

`DialogOverlayOwnProps`type

DialogOverlayOwnProps: {
  forceMount?: boolean;
}

Own props for Dialog Overlay, before merging with native element attributes.

forceMount: forceMount?: boolean | undefined;

`DialogOverlayProps`type

DialogOverlayProps: BoxProps<'div', HTMLDivElement> & DialogOverlayOwnProps

Props for Dialog Overlay.

asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;

`DialogOwnProps`type

DialogOwnProps: {
  children?: unknown;
  id?: string;
  open?: boolean;
  defaultOpen?: boolean;
  onOpenChange?: (open: boolean) => void;
  modal?: boolean;
}

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

children: children?: unknown;
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
modal: modal?: boolean | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;

`DialogPortal`type

DialogPortal: (props: DialogPortalProps) => JSX.Element | null

Renders a part of dialog.

`DialogPortalProps`type

DialogPortalProps: {
  children?: unknown;
}

Props for Dialog Portal.

children: children?: unknown;

`DialogProps`type

DialogProps: DialogOwnProps

Props for Dialog.

children: children?: unknown;
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
modal: modal?: boolean | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;

`DialogTitle`type

DialogTitle: { (props: DialogTitleProps): JSX.Element; (props: DialogTitleAsChildProps): JSX.Element; }

Renders the dialog-title part of dialog. Supports polymorphic rendering via asChild.

`DialogTitleAsChildProps`type

DialogTitleAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Dialog Title.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`DialogTitleProps`type

DialogTitleProps: BoxProps<'h2', HTMLHeadingElement>

Props for Dialog Title.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLHeadingElement>;

`DialogTrigger`type

DialogTrigger: { (props: DialogTriggerProps): JSX.Element; (props: DialogTriggerAsChildProps): JSX.Element; }

Renders the dialog-trigger part of dialog. Supports polymorphic rendering via asChild.

`DialogTriggerAsChildProps`type

DialogTriggerAsChildProps: ButtonLikeAsChildProps

Props for the asChild (polymorphic) rendering of Dialog Trigger.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`DialogTriggerProps`type

DialogTriggerProps: ButtonLikeProps<'button', HTMLButtonElement>

Props for Dialog Trigger.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`DismissableLayer`type

DismissableLayer: { (props: DismissableLayerProps): JSX.Element; (props: DismissableLayerAsChildProps): JSX.Element; }

Renders a part of dismissable-layer. Supports polymorphic rendering via asChild.

`DismissableLayerAsChildProps`type

DismissableLayerAsChildProps: DismissableLayerOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<Element>;
}

Props for the asChild (polymorphic) rendering of Dismissable Layer.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
disableOutsidePointerEvents: disableOutsidePointerEvents?: boolean | undefined;
id: id?: string | undefined;
onDismiss: onDismiss?: (() => void) | undefined;
onEscapeKeyDown: onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside: onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside: onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;
ref: ref?: Ref<Element>;

`DismissableLayerOwnProps`type

DismissableLayerOwnProps: {
  children?: unknown;
  id?: string;
  disabled?: boolean;
  disableOutsidePointerEvents?: boolean;
  onEscapeKeyDown?: (event: KeyboardEvent) => void;
  onPointerDownOutside?: (event: PointerEvent) => void;
  onInteractOutside?: (event: Event) => void;
  onDismiss?: () => void;
}

Own props for Dismissable Layer, before merging with native element attributes.

children: children?: unknown;
disabled: disabled?: boolean | undefined;
disableOutsidePointerEvents: disableOutsidePointerEvents?: boolean | undefined;
id: id?: string | undefined;
onDismiss: onDismiss?: (() => void) | undefined;
onEscapeKeyDown: onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside: onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside: onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;

`DismissableLayerProps`type

DismissableLayerProps: Omit<JSX.IntrinsicElements['div'], 'children' | 'ref'> & DismissableLayerOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLDivElement>;
}

Props for Dismissable Layer.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
disableOutsidePointerEvents: disableOutsidePointerEvents?: boolean | undefined;
id: id?: string | undefined;
onDismiss: onDismiss?: (() => void) | undefined;
onEscapeKeyDown: onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside: onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside: onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;
ref: ref?: Ref<HTMLDivElement>;

`Dropdown`type

Dropdown: (props: DropdownProps) => JSX.Element

Renders a part of dropdown.

`DropdownContent`type

DropdownContent: { (props: DropdownContentProps): JSX.Element | null; (props: DropdownContentAsChildProps): JSX.Element | null; }

Renders a part of dropdown. Supports polymorphic rendering via asChild.

`DropdownContentAsChildProps`type

DropdownContentAsChildProps: BoxAsChildProps & DropdownContentOwnProps

Props for the asChild (polymorphic) rendering of Dropdown Content.

align: align?: OverlayAlign | undefined;
asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<Element>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`DropdownContentOwnProps`type

DropdownContentOwnProps: {
  forceMount?: boolean;
  side?: OverlaySide;
  align?: OverlayAlign;
  sideOffset?: number;
}

Own props for Dropdown Content, before merging with native element attributes.

align: align?: OverlayAlign | undefined;
forceMount: forceMount?: boolean | undefined;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`DropdownContentProps`type

DropdownContentProps: BoxProps<'div', HTMLDivElement> & DropdownContentOwnProps

Props for Dropdown Content.

align: align?: OverlayAlign | undefined;
asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`DropdownGroup`type

DropdownGroup: (props: DropdownGroupProps | DropdownGroupAsChildProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders the dropdown-group part of dropdown with role="group". Supports polymorphic rendering via asChild.

`DropdownGroupAsChildProps`type

DropdownGroupAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Dropdown Group.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`DropdownGroupProps`type

DropdownGroupProps: BoxProps<'div', HTMLDivElement>

Props for Dropdown Group.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`DropdownItem`type

DropdownItem: { (props: DropdownItemProps): JSX.Element | null; (props: DropdownItemAsChildProps): JSX.Element | null; }

Renders a part of dropdown. Supports polymorphic rendering via asChild.

`DropdownItemAsChildProps`type

DropdownItemAsChildProps: Omit<ButtonLikeAsChildProps, 'onPress'> & DropdownItemOwnProps

Props for the asChild (polymorphic) rendering of Dropdown Item.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onSelect: onSelect?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
textValue: Text used for typeahead when rendered children are not plain text.
type: type?: undefined;
value: value?: string | undefined;
variant: variant?: DropdownItemVariant | undefined;

`DropdownItemOwnProps`type

DropdownItemOwnProps: {
  children?: unknown;
  disabled?: boolean;
  value?: string;
  variant?: DropdownItemVariant;
  onSelect?: (event: PressEvent) => void;
  /** Text used for typeahead when rendered children are not plain text. */
  textValue?: string;
}

Own props for Dropdown Item, before merging with native element attributes.

children: children?: unknown;
disabled: disabled?: boolean | undefined;
onSelect: onSelect?: ((event: PressEvent) => void) | undefined;
textValue: Text used for typeahead when rendered children are not plain text.
value: value?: string | undefined;
variant: variant?: DropdownItemVariant | undefined;

`DropdownItemProps`type

DropdownItemProps: Omit<ButtonLikeProps<'button', HTMLButtonElement>, 'onPress'> & DropdownItemOwnProps

Props for Dropdown Item.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
ref: ref?: Ref<HTMLButtonElement>;
textValue: Text used for typeahead when rendered children are not plain text.
type: type?: "button" | "submit" | "reset" | undefined;
variant: variant?: DropdownItemVariant | undefined;

`DropdownItemVariant`type

DropdownItemVariant: 'default' | 'destructive'

Dropdown Item Variant.

`DropdownLabel`type

DropdownLabel: (props: DropdownLabelProps | DropdownLabelAsChildProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders the dropdown-label part of dropdown. Supports polymorphic rendering via asChild.

`DropdownLabelAsChildProps`type

DropdownLabelAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Dropdown Label.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`DropdownLabelProps`type

DropdownLabelProps: BoxProps<'div', HTMLDivElement>

Props for Dropdown Label.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`DropdownOwnProps`type

DropdownOwnProps: {
  /** Supports literal, nested, array-mapped, and `For`-rendered descendants. */
  children?: unknown;
  id?: string;
  open?: boolean;
  defaultOpen?: boolean;
  onOpenChange?: (open: boolean) => void;
}

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

children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;

`DropdownPortal`type

DropdownPortal: (props: DropdownPortalProps) => JSX.Element | null

Renders a part of dropdown.

`DropdownPortalProps`type

DropdownPortalProps: {
  children?: unknown;
}

Props for Dropdown Portal.

children: children?: unknown;

`DropdownProps`type

DropdownProps: DropdownOwnProps

Props for Dropdown.

children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;

`DropdownSeparator`type

DropdownSeparator: (props: DropdownSeparatorProps | DropdownSeparatorAsChildProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders the dropdown-separator part of dropdown with role="separator". Supports polymorphic rendering via asChild.

`DropdownSeparatorAsChildProps`type

DropdownSeparatorAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Dropdown Separator.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`DropdownSeparatorProps`type

DropdownSeparatorProps: BoxProps<'div', HTMLDivElement>

Props for Dropdown Separator.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`DropdownTrigger`type

DropdownTrigger: { (props: DropdownTriggerProps): JSX.Element | null; (props: DropdownTriggerAsChildProps): JSX.Element | null; }

Renders the dropdown-trigger part of dropdown. Supports polymorphic rendering via asChild.

`DropdownTriggerAsChildProps`type

DropdownTriggerAsChildProps: ButtonLikeAsChildProps & DropdownTriggerOwnProps

Props for the asChild (polymorphic) rendering of Dropdown Trigger.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
size: size?: DropdownTriggerSize | undefined;
type: type?: undefined;
variant: variant?: DropdownTriggerVariant | undefined;

`DropdownTriggerOwnProps`type

DropdownTriggerOwnProps: {
  variant?: DropdownTriggerVariant;
  size?: DropdownTriggerSize;
}

Own props for Dropdown Trigger, before merging with native element attributes.

size: size?: DropdownTriggerSize | undefined;
variant: variant?: DropdownTriggerVariant | undefined;

`DropdownTriggerProps`type

DropdownTriggerProps: ButtonLikeProps<'button', HTMLButtonElement> & DropdownTriggerOwnProps

Props for Dropdown Trigger.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
size: size?: DropdownTriggerSize | undefined;
type: type?: "button" | "submit" | "reset" | undefined;
variant: variant?: DropdownTriggerVariant | undefined;

`DropdownTriggerSize`type

DropdownTriggerSize: 'md' | 'icon'

Dropdown Trigger Size.

`DropdownTriggerVariant`type

DropdownTriggerVariant: 'default' | 'ghost'

Dropdown Trigger Variant.

`FocusScope`type

FocusScope: { (props: FocusScopeProps): JSX.Element; (props: FocusScopeAsChildProps): JSX.Element; }

Renders a part of focus-scope. Supports polymorphic rendering via asChild.

`FocusScopeAsChildProps`type

FocusScopeAsChildProps: FocusScopeOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<Element>;
}

Props for the asChild (polymorphic) rendering of Focus Scope.

asChild: asChild: true;
autoFocus: autoFocus?: boolean | undefined;
children: children: JSXElement;
id: id?: string | undefined;
loop: loop?: boolean | undefined;
ref: ref?: Ref<Element>;
restoreFocus: restoreFocus?: boolean | undefined;
restoreFocusTarget: restoreFocusTarget?: HTMLElement | (() => HTMLElement | null) | null | undefined;
tabIndex: tabIndex?: number | undefined;
trapped: trapped?: boolean | undefined;

`FocusScopeOwnProps`type

FocusScopeOwnProps: {
  children?: unknown;
  trapped?: boolean;
  loop?: boolean;
  autoFocus?: boolean;
  restoreFocus?: boolean;
  restoreFocusTarget?: HTMLElement | null | (() => HTMLElement | null);
  id?: string;
  tabIndex?: number;
}

Own props for Focus Scope, before merging with native element attributes.

autoFocus: autoFocus?: boolean | undefined;
children: children?: unknown;
id: id?: string | undefined;
loop: loop?: boolean | undefined;
restoreFocus: restoreFocus?: boolean | undefined;
restoreFocusTarget: restoreFocusTarget?: HTMLElement | (() => HTMLElement | null) | null | undefined;
tabIndex: tabIndex?: number | undefined;
trapped: trapped?: boolean | undefined;

`FocusScopeProps`type

FocusScopeProps: Omit<JSX.IntrinsicElements['div'], 'children' | 'ref'> & FocusScopeOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLDivElement>;
}

Props for Focus Scope.

asChild: asChild?: false | undefined;
autoFocus: autoFocus?: boolean | undefined;
children: children?: unknown;
id: id?: string | undefined;
loop: loop?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;
restoreFocus: restoreFocus?: boolean | undefined;
restoreFocusTarget: restoreFocusTarget?: HTMLElement | (() => HTMLElement | null) | null | undefined;
tabIndex: tabIndex?: number | undefined;
trapped: trapped?: boolean | undefined;

`Form`type

Form: { (props: FormProps): JSX.Element; (props: FormAsChildProps): JSX.Element; }

Renders a part of form. Supports polymorphic rendering via asChild.

`FormAsChildProps`type

FormAsChildProps: Omit<JSX.IntrinsicElements['form'], 'children' | 'ref'> & FormOwnProps & {
  asChild: true;
  children: JSX.Element;
  ref?: import('@askrjs/askr/foundations/utilities').Ref<Element>;
}

asChild keeps the form host supplied by the consumer, while retaining the native form attribute contract (method, action, target, encoding, etc.).

asChild: asChild: true;
children: children: JSX.Element;
ref: ref?: Ref<Element>;

`FormProps`type

FormProps: BoxProps<'form', HTMLFormElement> & FormOwnProps

Props for Form.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLFormElement>;

`HoverCard`type

HoverCard: (props: HoverCardProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders a part of hover-card.

`HoverCardAsChildProps`type

HoverCardAsChildProps: HoverCardOwnProps & {
  asChild: true;
  children: JSX.Element;
}

Props for the asChild (polymorphic) rendering of Hover Card.

asChild: asChild: true;
children: children: JSX.Element;
closeDelay: closeDelay?: number | undefined;
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;
openDelay: openDelay?: number | undefined;

`HoverCardContent`type

HoverCardContent: { (props: HoverCardContentProps): JSX.Element | null; (props: HoverCardContentAsChildProps): JSX.Element | null; }

Renders the hover-card-content part of hover-card with role="dialog". Supports polymorphic rendering via asChild.

`HoverCardContentAsChildProps`type

HoverCardContentAsChildProps: BoxAsChildProps & HoverCardContentOwnProps

Props for the asChild (polymorphic) rendering of Hover Card Content.

align: align?: OverlayAlign | undefined;
asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<Element>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`HoverCardContentProps`type

HoverCardContentProps: BoxProps<'div', HTMLDivElement> & HoverCardContentOwnProps

Props for Hover Card Content.

align: align?: OverlayAlign | undefined;
asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`HoverCardOwnProps`type

HoverCardOwnProps: {
  children?: unknown;
  id?: string;
  open?: boolean;
  defaultOpen?: boolean;
  onOpenChange?: (open: boolean) => void;
  openDelay?: number;
  closeDelay?: number;
}

Own props for Hover Card, before merging with native element attributes.

children: children?: unknown;
closeDelay: closeDelay?: number | undefined;
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;
openDelay: openDelay?: number | undefined;

`HoverCardPortal`type

HoverCardPortal: (props: HoverCardPortalProps) => JSX.Element | null

Renders a part of hover-card.

`HoverCardPortalProps`type

HoverCardPortalProps: {
  children?: unknown;
}

Props for Hover Card Portal.

children: children?: unknown;

`HoverCardProps`type

HoverCardProps: HoverCardOwnProps

Props for Hover Card.

children: children?: unknown;
closeDelay: closeDelay?: number | undefined;
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;
openDelay: openDelay?: number | undefined;

`HoverCardTrigger`type

HoverCardTrigger: { (props: HoverCardTriggerProps): JSX.Element; (props: HoverCardTriggerAsChildProps): JSX.Element; }

Renders the hover-card-trigger part of hover-card. Supports polymorphic rendering via asChild.

`HoverCardTriggerAsChildProps`type

HoverCardTriggerAsChildProps: ButtonLikeAsChildProps

Props for the asChild (polymorphic) rendering of Hover Card Trigger.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`HoverCardTriggerProps`type

HoverCardTriggerProps: ButtonLikeProps<'button', HTMLButtonElement>

Props for Hover Card Trigger.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`Input`type

Input: { (props: InputInputProps): JSX.Element; (props: InputAsChildProps): JSX.Element; }

Renders the input part of input. Supports polymorphic rendering via asChild.

`InputAsChildProps`type

InputAsChildProps: InputOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<Element>;
}

Props for the asChild (polymorphic) rendering of Input.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
ref: ref?: Ref<Element>;
tabIndex: tabIndex?: number | undefined;

`InputEvent`type

InputEvent: Event & {
  currentTarget: HTMLInputElement;
  target: HTMLInputElement;
}

Input Event.

`InputInputProps`type

InputInputProps: Omit<JSX.IntrinsicElements['input'], 'children' | 'ref'> & InputOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLInputElement>;
}

Props for Input Input.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLInputElement>;

`InputOwnProps`type

InputOwnProps: {
  children?: unknown;
  disabled?: boolean;
  tabIndex?: number;
}

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

children: children?: unknown;
disabled: disabled?: boolean | undefined;
tabIndex: tabIndex?: number | undefined;

`InputProps`type

InputProps: InputInputProps | InputAsChildProps

Props for Input.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLInputElement | null) => void) | { current: HTMLInputElement | null; } | null | undefined;

`Label`type

Label: { (props: LabelLabelProps): JSXElement; (props: LabelAsChildProps): JSXElement; }

Renders the label part of label. Supports polymorphic rendering via asChild.

`LabelAsChildProps`type

LabelAsChildProps: LabelOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<Element>;
}

Props for the asChild (polymorphic) rendering of Label.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`LabelLabelProps`type

LabelLabelProps: Omit<Props, 'children'> & LabelOwnProps & {
  asChild?: false;
  htmlFor?: string;
  ref?: Ref<HTMLLabelElement>;
}

Props for Label Label.

asChild: asChild?: false | undefined;
children: children?: unknown;
htmlFor: htmlFor?: string | undefined;
ref: ref?: Ref<HTMLLabelElement>;

`LabelOwnProps`type

LabelOwnProps: {
  children?: unknown;
}

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

children: children?: unknown;

`LabelProps`type

LabelProps: LabelLabelProps | LabelAsChildProps

Props for Label.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLLabelElement | null) => void) | { current: HTMLLabelElement | null; } | null | undefined;

`Menu`type

Menu: (props: MenuProps) => JSX.Element

Renders a part of menu.

`Menubar`type

Menubar: (props: MenubarProps) => JSX.Element

Renders a part of menubar.

`MenubarContent`type

MenubarContent: { (props: MenubarContentProps): JSX.Element | null; (props: MenubarContentAsChildProps): JSX.Element | null; }

Renders a part of menubar.

`MenubarContentAsChildProps`type

MenubarContentAsChildProps: BoxAsChildProps & MenubarContentOwnProps

Props for the asChild (polymorphic) rendering of Menubar Content.

align: align?: OverlayAlign | undefined;
asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<Element>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`MenubarContentOwnProps`type

MenubarContentOwnProps: {
  forceMount?: boolean;
  side?: OverlaySide;
  align?: OverlayAlign;
  sideOffset?: number;
}

Own props for Menubar Content, before merging with native element attributes.

align: align?: OverlayAlign | undefined;
forceMount: forceMount?: boolean | undefined;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`MenubarContentProps`type

MenubarContentProps: BoxProps<'div', HTMLDivElement> & MenubarContentOwnProps

Props for Menubar Content.

align: align?: OverlayAlign | undefined;
asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`MenubarGroup`type

MenubarGroup: (props: MenubarGroupProps | MenubarGroupAsChildProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders the menubar-group part of menubar with role="group". Supports polymorphic rendering via asChild.

`MenubarGroupAsChildProps`type

MenubarGroupAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Menubar Group.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`MenubarGroupProps`type

MenubarGroupProps: BoxProps<'div', HTMLDivElement>

Props for Menubar Group.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`MenubarItem`type

MenubarItem: { (props: MenubarItemProps): JSX.Element | null; (props: MenubarItemAsChildProps): JSX.Element | null; }

Renders a part of menubar. Supports polymorphic rendering via asChild.

`MenubarItemAsChildProps`type

MenubarItemAsChildProps: ButtonLikeAsChildProps & MenubarTextValueOwnProps

Props for the asChild (polymorphic) rendering of Menubar Item.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
textValue: Text used for typeahead when rendered children are not plain text.
type: type?: undefined;

`MenubarItemProps`type

MenubarItemProps: ButtonLikeProps<'button', HTMLButtonElement> & MenubarTextValueOwnProps

Props for Menubar Item.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
textValue: Text used for typeahead when rendered children are not plain text.
type: type?: "button" | "submit" | "reset" | undefined;

`MenubarLabel`type

MenubarLabel: (props: MenubarLabelProps | MenubarLabelAsChildProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders the menubar-label part of menubar. Supports polymorphic rendering via asChild.

`MenubarLabelAsChildProps`type

MenubarLabelAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Menubar Label.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`MenubarLabelProps`type

MenubarLabelProps: BoxProps<'div', HTMLDivElement>

Props for Menubar Label.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`MenubarMenu`type

MenubarMenu: (props: MenubarMenuProps) => JSX.Element

Renders a part of menubar.

`MenubarMenuProps`type

MenubarMenuProps: {
  children?: unknown;
  /** Stable and unique among sibling menus when menus are rendered dynamically. */
  value?: string;
}

Props for Menubar Menu.

children: children?: unknown;
value: Stable and unique among sibling menus when menus are rendered dynamically.

`MenubarOwnProps`type

MenubarOwnProps: {
  /** Supports literal, nested, array-mapped, and `For`-rendered descendants. */
  children?: unknown;
  id?: string;
  loop?: boolean;
}

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

children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
id: id?: string | undefined;
loop: loop?: boolean | undefined;

`MenubarPortal`type

MenubarPortal: (props: MenubarPortalProps) => JSX.Element | null

Renders a part of menubar.

`MenubarPortalProps`type

MenubarPortalProps: {
  children?: unknown;
}

Props for Menubar Portal.

children: children?: unknown;

`MenubarProps`type

MenubarProps: BoxProps<'div', HTMLDivElement> & MenubarOwnProps

Props for Menubar.

asChild: asChild?: false | undefined;
children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
id: id?: string | undefined;
loop: loop?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;

`MenubarSeparator`type

MenubarSeparator: (props: MenubarSeparatorProps | MenubarSeparatorAsChildProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders the menubar-separator part of menubar with role="separator". Supports polymorphic rendering via asChild.

`MenubarSeparatorAsChildProps`type

MenubarSeparatorAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Menubar Separator.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`MenubarSeparatorProps`type

MenubarSeparatorProps: BoxProps<'div', HTMLDivElement>

Props for Menubar Separator.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`MenubarSub`type

MenubarSub: (props: MenubarSubProps) => JSX.Element

Renders a part of menubar.

`MenubarSubContent`type

MenubarSubContent: { (props: MenubarSubContentProps): JSX.Element | null; (props: MenubarSubContentAsChildProps): JSX.Element | null; }

Renders a part of menubar.

`MenubarSubContentAsChildProps`type

MenubarSubContentAsChildProps: BoxAsChildProps & MenubarContentOwnProps

Props for the asChild (polymorphic) rendering of Menubar Sub Content.

align: align?: OverlayAlign | undefined;
asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<Element>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`MenubarSubContentProps`type

MenubarSubContentProps: BoxProps<'div', HTMLDivElement> & MenubarContentOwnProps

Props for Menubar Sub Content.

align: align?: OverlayAlign | undefined;
asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`MenubarSubProps`type

MenubarSubProps: {
  children?: unknown;
  value?: string;
}

Props for Menubar Sub.

children: children?: unknown;
value: value?: string | undefined;

`MenubarSubTrigger`type

MenubarSubTrigger: { (props: MenubarSubTriggerProps): JSX.Element | null; (props: MenubarSubTriggerAsChildProps): JSX.Element | null; }

Renders a part of menubar. Supports polymorphic rendering via asChild.

`MenubarSubTriggerAsChildProps`type

MenubarSubTriggerAsChildProps: ButtonLikeAsChildProps & MenubarTextValueOwnProps

Props for the asChild (polymorphic) rendering of Menubar Sub Trigger.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
textValue: Text used for typeahead when rendered children are not plain text.
type: type?: undefined;

`MenubarSubTriggerProps`type

MenubarSubTriggerProps: ButtonLikeProps<'button', HTMLButtonElement> & MenubarTextValueOwnProps

Props for Menubar Sub Trigger.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
textValue: Text used for typeahead when rendered children are not plain text.
type: type?: "button" | "submit" | "reset" | undefined;

`MenubarTrigger`type

MenubarTrigger: { (props: MenubarTriggerProps): JSX.Element | null; (props: MenubarTriggerAsChildProps): JSX.Element | null; }

Renders a part of menubar. Supports polymorphic rendering via asChild.

`MenubarTriggerAsChildProps`type

MenubarTriggerAsChildProps: ButtonLikeAsChildProps & MenubarTextValueOwnProps

Props for the asChild (polymorphic) rendering of Menubar Trigger.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
textValue: Text used for typeahead when rendered children are not plain text.
type: type?: undefined;

`MenubarTriggerProps`type

MenubarTriggerProps: ButtonLikeProps<'button', HTMLButtonElement> & MenubarTextValueOwnProps

Props for Menubar Trigger.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
textValue: Text used for typeahead when rendered children are not plain text.
type: type?: "button" | "submit" | "reset" | undefined;

`MenuContent`type

MenuContent: { (props: MenuContentProps): JSX.Element; (props: MenuContentAsChildProps): JSX.Element; }

Renders the menu-content part of menu with role="menu". Supports polymorphic rendering via asChild.

`MenuContentAsChildProps`type

MenuContentAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Menu Content.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`MenuContentProps`type

MenuContentProps: BoxProps<'div', HTMLDivElement>

Props for Menu Content.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`MenuGroup`type

MenuGroup: { (props: MenuGroupProps): JSX.Element; (props: MenuGroupAsChildProps): JSX.Element; }

Renders the menu-group part of menu with role="group". Supports polymorphic rendering via asChild.

`MenuGroupAsChildProps`type

MenuGroupAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Menu Group.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`MenuGroupProps`type

MenuGroupProps: BoxProps<'div', HTMLDivElement>

Props for Menu Group.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`MenuItem`type

MenuItem: { (props: MenuItemProps): JSX.Element | null; (props: MenuItemAsChildProps): JSX.Element | null; }

Renders the menu-item part of menu with role="menuitem". Supports polymorphic rendering via asChild.

`MenuItemAsChildProps`type

MenuItemAsChildProps: Omit<ButtonLikeAsChildProps, 'onPress'> & MenuItemOwnProps

Props for the asChild (polymorphic) rendering of Menu Item.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onSelect: onSelect?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
textValue: Text used for typeahead when rendered children are not plain text.
type: type?: undefined;

`MenuItemDescription`type

MenuItemDescription: { (props: MenuItemPartProps): JSX.Element; (props: MenuItemPartAsChildProps): JSX.Element; }

Optional supporting description for a structured Menu Item.

`MenuItemIcon`type

MenuItemIcon: { (props: MenuItemPartProps): JSX.Element; (props: MenuItemPartAsChildProps): JSX.Element; }

Optional leading visual for a Menu Item.

`MenuItemLabel`type

MenuItemLabel: { (props: MenuItemPartProps): JSX.Element; (props: MenuItemPartAsChildProps): JSX.Element; }

Primary visible label for a structured Menu Item.

`MenuItemOwnProps`type

MenuItemOwnProps: {
  children?: unknown;
  disabled?: boolean;
  onSelect?: (event: PressEvent) => void;
  /** Text used for typeahead when rendered children are not plain text. */
  textValue?: string;
}

Own props for Menu Item, before merging with native element attributes.

children: children?: unknown;
disabled: disabled?: boolean | undefined;
onSelect: onSelect?: ((event: PressEvent) => void) | undefined;
textValue: Text used for typeahead when rendered children are not plain text.

`MenuItemPartAsChildProps`type

MenuItemPartAsChildProps: BoxAsChildProps

Props for a polymorphic presentational part within a Menu Item.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`MenuItemPartProps`type

MenuItemPartProps: BoxProps<'span', HTMLSpanElement>

Props for a presentational part within a Menu Item.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLSpanElement>;

`MenuItemProps`type

MenuItemProps: Omit<ButtonLikeProps<'button', HTMLButtonElement>, 'onPress'> & MenuItemOwnProps

Props for Menu Item.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
ref: ref?: Ref<HTMLButtonElement>;
textValue: Text used for typeahead when rendered children are not plain text.
type: type?: "button" | "submit" | "reset" | undefined;

`MenuLabel`type

MenuLabel: { (props: MenuLabelProps): JSX.Element | null; (props: MenuLabelAsChildProps): JSX.Element | null; }

Renders the menu-label part of menu. Supports polymorphic rendering via asChild.

`MenuLabelAsChildProps`type

MenuLabelAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Menu Label.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`MenuLabelProps`type

MenuLabelProps: BoxProps<'div', HTMLDivElement>

Props for Menu Label.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`MenuOwnProps`type

MenuOwnProps: {
  /** Supports literal, nested, array-mapped, and `For`-rendered descendants. */
  children?: unknown;
  id?: string;
  orientation?: Orientation;
  loop?: boolean;
}

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

children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
id: id?: string | undefined;
loop: loop?: boolean | undefined;
orientation: orientation?: Orientation | undefined;

`MenuProps`type

MenuProps: MenuOwnProps

Props for Menu.

children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
id: id?: string | undefined;
loop: loop?: boolean | undefined;
orientation: orientation?: Orientation | undefined;

`MenuSeparator`type

MenuSeparator: { (props: MenuSeparatorProps): JSX.Element | null; (props: MenuSeparatorAsChildProps): JSX.Element | null; }

Renders the menu-separator part of menu with role="separator". Supports polymorphic rendering via asChild.

`MenuSeparatorAsChildProps`type

MenuSeparatorAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Menu Separator.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`MenuSeparatorProps`type

MenuSeparatorProps: BoxProps<'div', HTMLDivElement>

Props for Menu Separator.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`OverlayHost`type

OverlayHost: (props: OverlayHostProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

`OverlayHostProps`type

OverlayHostProps: {
  children?: unknown;
}

children: children?: unknown;

`Popover`type

Popover: (props: PopoverProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders a part of popover.

`PopoverClose`type

PopoverClose: { (props: PopoverCloseProps): JSX.Element; (props: PopoverCloseAsChildProps): JSX.Element; }

Renders the popover-close part of popover. Supports polymorphic rendering via asChild.

`PopoverCloseAsChildProps`type

PopoverCloseAsChildProps: ButtonLikeAsChildProps

Props for the asChild (polymorphic) rendering of Popover Close.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`PopoverCloseProps`type

PopoverCloseProps: ButtonLikeProps<'button', HTMLButtonElement>

Props for Popover Close.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`PopoverContent`type

PopoverContent: { (props: PopoverContentProps): JSX.Element | null; (props: PopoverContentAsChildProps): JSX.Element | null; }

Renders the popover-content part of popover with role="dialog". Supports polymorphic rendering via asChild.

`PopoverContentAsChildProps`type

PopoverContentAsChildProps: BoxAsChildProps & PopoverContentOwnProps

Props for the asChild (polymorphic) rendering of Popover Content.

align: align?: OverlayAlign | undefined;
asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<Element>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;
width: width?: PopoverContentWidth | undefined;

`PopoverContentOwnProps`type

PopoverContentOwnProps: {
  forceMount?: boolean;
  side?: OverlaySide;
  align?: OverlayAlign;
  sideOffset?: number;
  width?: PopoverContentWidth;
}

Own props for Popover Content, before merging with native element attributes.

align: align?: OverlayAlign | undefined;
forceMount: forceMount?: boolean | undefined;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;
width: width?: PopoverContentWidth | undefined;

`PopoverContentProps`type

PopoverContentProps: BoxProps<'div', HTMLDivElement> & PopoverContentOwnProps

Props for Popover Content.

align: align?: OverlayAlign | undefined;
asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;
width: width?: PopoverContentWidth | undefined;

`PopoverContentWidth`type

PopoverContentWidth: 'sm' | 'md' | 'lg'

Popover Content Width.

`PopoverOwnProps`type

PopoverOwnProps: {
  children?: unknown;
  id?: string;
  open?: boolean;
  defaultOpen?: boolean;
  onOpenChange?: (open: boolean) => void;
}

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

children: children?: unknown;
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;

`PopoverPortal`type

PopoverPortal: (props: PopoverPortalProps) => JSX.Element | null

Renders a part of popover.

`PopoverPortalProps`type

PopoverPortalProps: {
  children?: unknown;
}

Props for Popover Portal.

children: children?: unknown;

`PopoverProps`type

PopoverProps: PopoverOwnProps

Props for Popover.

children: children?: unknown;
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;

`PopoverTrigger`type

PopoverTrigger: { (props: PopoverTriggerProps): JSX.Element; (props: PopoverTriggerAsChildProps): JSX.Element; }

Renders the popover-trigger part of popover. Supports polymorphic rendering via asChild.

`PopoverTriggerAsChildProps`type

PopoverTriggerAsChildProps: ButtonLikeAsChildProps

Props for the asChild (polymorphic) rendering of Popover Trigger.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`PopoverTriggerProps`type

PopoverTriggerProps: ButtonLikeProps<'button', HTMLButtonElement>

Props for Popover Trigger.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`PressEvent`type

PressEvent: {
  preventDefault?: () => void;
  stopPropagation?: () => void;
  defaultPrevented?: boolean;
}

Press event passed to onPress handler Compatible with the pressable foundation's PressEvent type.

`Progress`type

Progress: (props: ProgressProps) => JSX.Element

Renders the progress part of progress with role="progressbar".

`ProgressCircle`type

ProgressCircle: (props: ProgressCircleProps) => JSX.Element

Headless circular progress indicator root. Normalizes value/max, computes percentage, exposes --ak-progress-percentage as a dynamically injected CSS custom property, and provides progress state to ProgressCircleIndicator via context.

`ProgressCircleIndicator`type

ProgressCircleIndicator: { (props: ProgressCircleIndicatorProps): JSX.Element; (props: ProgressCircleIndicatorAsChildProps): JSX.Element; }

Visual indicator for ProgressCircle, rendering the fill/arc element. Must be used within a ProgressCircle; reads progress state from context and exposes it as data-state/data-value/data-max/data-percentage.

`ProgressCircleIndicatorAsChildProps`type

ProgressCircleIndicatorAsChildProps: BoxAsChildProps

Props for ProgressCircleIndicator rendered polymorphically via asChild.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`ProgressCircleIndicatorProps`type

ProgressCircleIndicatorProps: BoxProps<'div', HTMLDivElement>

Props for ProgressCircleIndicator rendered as a native div.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`ProgressCircleOwnProps`type

ProgressCircleOwnProps: {
  children?: unknown;
  id?: string;
  value?: number | null;
  max?: number;
  getValueLabel?: (value: number | null, max: number) => string;
}

Props specific to ProgressCircle, before merging with native div attributes.

children: children?: unknown;
getValueLabel: getValueLabel?: ((value: number | null, max: number) => string) | undefined;
id: id?: string | undefined;
max: max?: number | undefined;
value: value?: number | null | undefined;

`ProgressCircleProps`type

ProgressCircleProps: BoxProps<'div', HTMLDivElement> & ProgressCircleOwnProps

Props for ProgressCircle, combining native div attributes with ProgressCircleOwnProps.

asChild: asChild?: false | undefined;
children: children?: unknown;
getValueLabel: getValueLabel?: ((value: number | null, max: number) => string) | undefined;
id: id?: string | undefined;
max: max?: number | undefined;
ref: ref?: Ref<HTMLDivElement>;
value: value?: number | null | undefined;

`ProgressIndicator`type

ProgressIndicator: { (props: ProgressIndicatorProps): JSX.Element; (props: ProgressIndicatorAsChildProps): JSX.Element; }

Renders the progress-indicator part of progress. Supports polymorphic rendering via asChild.

`ProgressIndicatorAsChildProps`type

ProgressIndicatorAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Progress Indicator.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`ProgressIndicatorProps`type

ProgressIndicatorProps: BoxProps<'div', HTMLDivElement>

Props for Progress Indicator.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`ProgressOwnProps`type

ProgressOwnProps: {
  children?: unknown;
  id?: string;
  value?: number | null;
  max?: number;
  getValueLabel?: (value: number | null, max: number) => string;
}

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

children: children?: unknown;
getValueLabel: getValueLabel?: ((value: number | null, max: number) => string) | undefined;
id: id?: string | undefined;
max: max?: number | undefined;
value: value?: number | null | undefined;

`ProgressProps`type

ProgressProps: BoxProps<'div', HTMLDivElement> & ProgressOwnProps

Props for Progress.

asChild: asChild?: false | undefined;
children: children?: unknown;
getValueLabel: getValueLabel?: ((value: number | null, max: number) => string) | undefined;
id: id?: string | undefined;
max: max?: number | undefined;
ref: ref?: Ref<HTMLDivElement>;
value: value?: number | null | undefined;

`RadioGroup`type

RadioGroup: (props: RadioGroupProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders a part of radio-group.

`RadioGroupItem`type

RadioGroupItem: { (props: RadioGroupItemProps): JSX.Element; (props: RadioGroupItemAsChildProps): JSX.Element; }

Renders the radio-group-item part of radio-group with role="radio". Supports polymorphic rendering via asChild.

`RadioGroupItemAsChildProps`type

RadioGroupItemAsChildProps: RadioGroupItemOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<Element>;
}

Props for the asChild (polymorphic) rendering of Radio Group Item.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
ref: ref?: Ref<Element>;
value: value: string;

`RadioGroupItemOwnProps`type

RadioGroupItemOwnProps: {
  value: string;
  disabled?: boolean;
  children?: unknown;
}

Own props for Radio Group Item, before merging with native element attributes.

children: children?: unknown;
disabled: disabled?: boolean | undefined;
value: value: string;

`RadioGroupItemProps`type

RadioGroupItemProps: Omit<JSX.IntrinsicElements['button'], 'children' | 'ref' | 'onClick' | 'type' | 'value'> & RadioGroupItemOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLButtonElement>;
}

Props for Radio Group Item.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLButtonElement>;
value: value: string;

`RadioGroupOwnProps`type

RadioGroupOwnProps: {
  value?: string;
  defaultValue?: string;
  onValueChange?: (value: string) => void;
  disabled?: boolean;
  name?: string;
  orientation?: Orientation;
  loop?: boolean;
  /** Supports literal, nested, array-mapped, and `For`-rendered descendants. */
  children?: unknown;
}

Own props for Radio Group, before merging with native element attributes.

children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultValue: defaultValue?: string | undefined;
disabled: disabled?: boolean | undefined;
loop: loop?: boolean | undefined;
name: name?: string | undefined;
onValueChange: onValueChange?: ((value: string) => void) | undefined;
orientation: orientation?: Orientation | undefined;
value: value?: string | undefined;

`RadioGroupProps`type

RadioGroupProps: Omit<JSX.IntrinsicElements['div'], 'children' | 'ref'> & RadioGroupOwnProps & {
  ref?: Ref<HTMLDivElement>;
}

Props for Radio Group.

children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultValue: defaultValue?: string | undefined;
disabled: disabled?: boolean | undefined;
loop: loop?: boolean | undefined;
name: name?: string | undefined;
onValueChange: onValueChange?: ((value: string) => void) | undefined;
orientation: orientation?: Orientation | undefined;
ref: ref?: Ref<HTMLDivElement>;
value: value?: string | undefined;

`ScrollArea`type

ScrollArea: { (props: ScrollAreaProps): JSX.Element; (props: ScrollAreaAsChildProps): JSX.Element; }

Renders a part of scroll-area.

`ScrollAreaAsChildProps`type

ScrollAreaAsChildProps: ScrollAreaOwnProps & {
  asChild: true;
  children: JSX.Element;
}

Props for the asChild (polymorphic) rendering of Scroll Area.

asChild: asChild: true;
children: children: JSX.Element;
id: id?: string | undefined;

`ScrollAreaCorner`type

ScrollAreaCorner: (props: ScrollAreaCornerProps) => JSX.Element

Renders the scroll-area-corner part of scroll-area.

`ScrollAreaCornerProps`type

ScrollAreaCornerProps: BoxProps<'div', HTMLDivElement>

Props for Scroll Area Corner.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`ScrollAreaOwnProps`type

ScrollAreaOwnProps: {
  children?: unknown;
  id?: string;
}

Own props for Scroll Area, before merging with native element attributes.

children: children?: unknown;
id: id?: string | undefined;

`ScrollAreaProps`type

ScrollAreaProps: ScrollAreaOwnProps

Props for Scroll Area.

children: children?: unknown;
id: id?: string | undefined;

`ScrollAreaScrollbar`type

ScrollAreaScrollbar: (props: ScrollAreaScrollbarProps) => JSX.Element

Renders the scroll-area-scrollbar part of scroll-area with role="scrollbar".

`ScrollAreaScrollbarProps`type

ScrollAreaScrollbarProps: BoxProps<'div', HTMLDivElement> & {
  orientation?: 'vertical' | 'horizontal';
}

Props for Scroll Area Scrollbar.

asChild: asChild?: false | undefined;
children: children?: unknown;
orientation: orientation?: "vertical" | "horizontal" | undefined;
ref: ref?: Ref<HTMLDivElement>;

`ScrollAreaThumb`type

ScrollAreaThumb: (props: ScrollAreaThumbProps) => JSX.Element

Renders the scroll-area-thumb part of scroll-area.

`ScrollAreaThumbProps`type

ScrollAreaThumbProps: BoxProps<'div', HTMLDivElement>

Props for Scroll Area Thumb.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`ScrollAreaViewport`type

ScrollAreaViewport: { (props: ScrollAreaViewportProps): JSX.Element; (props: ScrollAreaViewportAsChildProps): JSX.Element; }

Renders a part of scroll-area.

`ScrollAreaViewportAsChildProps`type

ScrollAreaViewportAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Scroll Area Viewport.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`ScrollAreaViewportProps`type

ScrollAreaViewportProps: BoxProps<'div', HTMLDivElement>

Props for Scroll Area Viewport.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`Select`type

Select: (props: SelectProps) => JSX.Element

Renders a part of select.

`SelectContent`type

SelectContent: { (props: SelectContentProps): JSX.Element | null; (props: SelectContentAsChildProps): JSX.Element | null; }

Renders a part of select with role="listbox". Supports polymorphic rendering via asChild.

`SelectContentAsChildProps`type

SelectContentAsChildProps: BoxAsChildProps & SelectContentOwnProps

Props for the asChild (polymorphic) rendering of Select Content.

align: align?: OverlayAlign | undefined;
asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<Element>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`SelectContentOwnProps`type

SelectContentOwnProps: {
  forceMount?: boolean;
  side?: OverlaySide;
  align?: OverlayAlign;
  sideOffset?: number;
}

Own props for Select Content, before merging with native element attributes.

align: align?: OverlayAlign | undefined;
forceMount: forceMount?: boolean | undefined;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`SelectContentProps`type

SelectContentProps: BoxProps<'div', HTMLDivElement> & SelectContentOwnProps

Props for Select Content.

align: align?: OverlayAlign | undefined;
asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`SelectGroup`type

SelectGroup: { (props: SelectGroupProps): JSX.Element; (props: SelectGroupAsChildProps): JSX.Element; }

Renders the select-group part of select with role="group". Supports polymorphic rendering via asChild.

`SelectGroupAsChildProps`type

SelectGroupAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Select Group.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`SelectGroupProps`type

SelectGroupProps: BoxProps<'div', HTMLDivElement>

Props for Select Group.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`SelectItem`type

SelectItem: { (props: SelectItemProps): JSX.Element | null; (props: SelectItemAsChildProps): JSX.Element | null; }

Renders a part of select. Supports polymorphic rendering via asChild.

`SelectItemAsChildProps`type

SelectItemAsChildProps: Omit<ButtonLikeAsChildProps, 'onPress'> & SelectItemOwnProps

Props for the asChild (polymorphic) rendering of Select Item.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
ref: ref?: Ref<Element>;
textValue: textValue?: string | undefined;
type: type?: undefined;
value: value: string;

`SelectItemOwnProps`type

SelectItemOwnProps: {
  children?: unknown;
  disabled?: boolean;
  textValue?: string;
  value: string;
}

Own props for Select Item, before merging with native element attributes.

children: children?: unknown;
disabled: disabled?: boolean | undefined;
textValue: textValue?: string | undefined;
value: value: string;

`SelectItemProps`type

SelectItemProps: Omit<ButtonLikeProps<'button', HTMLButtonElement>, 'onPress'> & SelectItemOwnProps

Props for Select Item.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
ref: ref?: Ref<HTMLButtonElement>;
textValue: textValue?: string | undefined;
type: type?: "button" | "submit" | "reset" | undefined;

`SelectItemText`type

SelectItemText: { (props: SelectItemTextProps): JSX.Element; (props: SelectItemTextAsChildProps): JSX.Element; }

SelectItemText marks the item text node so Select can resolve labels and style the text slot directly. Renders the select-item-text part of select. Supports polymorphic rendering via asChild.

`SelectItemTextAsChildProps`type

SelectItemTextAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Select Item Text.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`SelectItemTextProps`type

SelectItemTextProps: BoxProps<'span', HTMLSpanElement>

Props for Select Item Text.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLSpanElement>;

`SelectLabel`type

SelectLabel: { (props: SelectLabelProps): JSX.Element | null; (props: SelectLabelAsChildProps): JSX.Element | null; }

Renders the select-label part of select. Supports polymorphic rendering via asChild.

`SelectLabelAsChildProps`type

SelectLabelAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Select Label.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`SelectLabelProps`type

SelectLabelProps: BoxProps<'div', HTMLDivElement>

Props for Select Label.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`SelectOwnProps`type

SelectOwnProps: {
  /** Supports literal, nested, array-mapped, and `For`-rendered descendants. */
  children?: unknown;
  id?: string;
  value?: string;
  defaultValue?: string;
  onValueChange?: (value: string) => void;
  open?: boolean;
  defaultOpen?: boolean;
  onOpenChange?: (open: boolean) => void;
  name?: string;
  disabled?: boolean;
}

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

children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultOpen: defaultOpen?: boolean | undefined;
defaultValue: defaultValue?: string | undefined;
disabled: disabled?: boolean | undefined;
id: id?: string | undefined;
name: name?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
onValueChange: onValueChange?: ((value: string) => void) | undefined;
open: open?: boolean | undefined;
value: value?: string | undefined;

`SelectPortal`type

SelectPortal: (props: SelectPortalProps) => JSX.Element | null

Renders a part of select.

`SelectPortalProps`type

SelectPortalProps: {
  children?: unknown;
}

Props for Select Portal.

children: children?: unknown;

`SelectProps`type

SelectProps: SelectOwnProps

Props for Select.

children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultOpen: defaultOpen?: boolean | undefined;
defaultValue: defaultValue?: string | undefined;
disabled: disabled?: boolean | undefined;
id: id?: string | undefined;
name: name?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
onValueChange: onValueChange?: ((value: string) => void) | undefined;
open: open?: boolean | undefined;
value: value?: string | undefined;

`SelectSeparator`type

SelectSeparator: { (props: SelectSeparatorProps): JSX.Element | null; (props: SelectSeparatorAsChildProps): JSX.Element | null; }

Renders the select-separator part of select with role="separator". Supports polymorphic rendering via asChild.

`SelectSeparatorAsChildProps`type

SelectSeparatorAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Select Separator.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`SelectSeparatorProps`type

SelectSeparatorProps: BoxProps<'div', HTMLDivElement>

Props for Select Separator.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`SelectTrigger`type

SelectTrigger: { (props: SelectTriggerProps): JSX.Element | null; (props: SelectTriggerAsChildProps): JSX.Element | null; }

Renders the select-trigger part of select. Supports polymorphic rendering via asChild.

`SelectTriggerAsChildProps`type

SelectTriggerAsChildProps: ButtonLikeAsChildProps & SelectTriggerOwnProps

Props for the asChild (polymorphic) rendering of Select Trigger.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
size: size?: SelectTriggerSize | undefined;
type: type?: undefined;

`SelectTriggerOwnProps`type

SelectTriggerOwnProps: {
  size?: SelectTriggerSize;
}

Own props for Select Trigger, before merging with native element attributes.

size: size?: SelectTriggerSize | undefined;

`SelectTriggerProps`type

SelectTriggerProps: ButtonLikeProps<'button', HTMLButtonElement> & SelectTriggerOwnProps

Props for Select Trigger.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
size: size?: SelectTriggerSize | undefined;
type: type?: "button" | "submit" | "reset" | undefined;

`SelectTriggerSize`type

SelectTriggerSize: 'sm' | 'md' | 'lg'

Select Trigger Size.

`SelectValue`type

SelectValue: { (props: SelectValueProps): JSX.Element | null; (props: SelectValueAsChildProps): JSX.Element | null; }

Renders the select-value part of select. Supports polymorphic rendering via asChild.

`SelectValueAsChildProps`type

SelectValueAsChildProps: BoxAsChildProps & SelectValueOwnProps

Props for the asChild (polymorphic) rendering of Select Value.

asChild: asChild: true;
children: children: JSXElement;
placeholder: placeholder?: string | undefined;
ref: ref?: Ref<Element>;

`SelectValueOwnProps`type

SelectValueOwnProps: {
  placeholder?: string;
  children?: unknown;
}

Own props for Select Value, before merging with native element attributes.

children: children?: unknown;
placeholder: placeholder?: string | undefined;

`SelectValueProps`type

SelectValueProps: BoxProps<'span', HTMLSpanElement> & SelectValueOwnProps

Props for Select Value.

asChild: asChild?: false | undefined;
children: children?: unknown;
placeholder: placeholder?: string | undefined;
ref: ref?: Ref<HTMLSpanElement>;

`Slider`type

Slider: (props: SliderProps) => JSX.Element

Renders the slider part of slider.

`SliderOrientation`type

SliderOrientation: 'horizontal' | 'vertical'

Slider Orientation.

`SliderOwnProps`type

SliderOwnProps: {
  /** Supports literal, nested, array-mapped, and `For`-rendered descendants. */
  children?: unknown;
  id?: string;
  value?: number;
  defaultValue?: number;
  onValueChange?: (value: number) => void;
  min?: number;
  max?: number;
  step?: number;
  orientation?: SliderOrientation;
  disabled?: boolean;
  name?: string;
}

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

children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultValue: defaultValue?: number | undefined;
disabled: disabled?: boolean | undefined;
id: id?: string | undefined;
max: max?: number | undefined;
min: min?: number | undefined;
name: name?: string | undefined;
onValueChange: onValueChange?: ((value: number) => void) | undefined;
orientation: orientation?: SliderOrientation | undefined;
step: step?: number | undefined;
value: value?: number | undefined;

`SliderProps`type

SliderProps: BoxProps<'div', HTMLDivElement> & SliderOwnProps

Props for Slider.

asChild: asChild?: false | undefined;
children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultValue: defaultValue?: number | undefined;
disabled: disabled?: boolean | undefined;
id: id?: string | undefined;
max: max?: number | undefined;
min: min?: number | undefined;
name: name?: string | undefined;
onValueChange: onValueChange?: ((value: number) => void) | undefined;
orientation: orientation?: SliderOrientation | undefined;
ref: ref?: Ref<HTMLDivElement>;
step: step?: number | undefined;
value: value?: number | undefined;

`SliderRange`type

SliderRange: { (props: SliderRangeProps): JSX.Element; (props: SliderRangeAsChildProps): JSX.Element; }

Renders the slider-range part of slider. Supports polymorphic rendering via asChild.

`SliderRangeAsChildProps`type

SliderRangeAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Slider Range.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`SliderRangeProps`type

SliderRangeProps: BoxProps<'div', HTMLDivElement>

Props for Slider Range.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`SliderThumb`type

SliderThumb: { (props: SliderThumbProps): JSX.Element; (props: SliderThumbAsChildProps): JSX.Element; }

Renders the slider-thumb part of slider with role="slider". Supports polymorphic rendering via asChild.

`SliderThumbAsChildProps`type

SliderThumbAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Slider Thumb.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`SliderThumbProps`type

SliderThumbProps: BoxProps<'div', HTMLDivElement>

Props for Slider Thumb.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`SliderTrack`type

SliderTrack: { (props: SliderTrackProps): JSX.Element; (props: SliderTrackAsChildProps): JSX.Element; }

Renders the slider-track part of slider. Supports polymorphic rendering via asChild.

`SliderTrackAsChildProps`type

SliderTrackAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Slider Track.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`SliderTrackProps`type

SliderTrackProps: BoxProps<'div', HTMLDivElement>

Props for Slider Track.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`Switch`type

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

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

`SwitchAsChildProps`type

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;

`SwitchButtonProps`type

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;

`SwitchOwnProps`type

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;

`SwitchProps`type

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;

`Table`type

Table: { (props: TableProps): JSX.Element; (props: TableAsChildProps): JSX.Element; }

Semantic table primitive family. Renders a part of table. Supports polymorphic rendering via asChild.

`TableAsChildProps`type

TableAsChildProps: TableAsChildBaseProps

Props for the asChild (polymorphic) rendering of Table.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`TableBody`type

TableBody: { (props: TableBodyProps): JSX.Element; (props: TableBodyAsChildProps): JSX.Element; }

Renders a part of table. Supports polymorphic rendering via asChild.

`TableBodyAsChildProps`type

TableBodyAsChildProps: TableAsChildBaseProps

Props for the asChild (polymorphic) rendering of Table Body.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`TableBodyProps`type

TableBodyProps: TableNativeProps<'tbody', HTMLTableSectionElement> | TableBodyAsChildProps

Props for Table Body.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLTableSectionElement | null) => void) | { current: HTMLTableSectionElement | null; } | null | undefined;

`TableCaption`type

TableCaption: { (props: TableCaptionProps): JSX.Element; (props: TableCaptionAsChildProps): JSX.Element; }

Renders a part of table. Supports polymorphic rendering via asChild.

`TableCaptionAsChildProps`type

TableCaptionAsChildProps: TableAsChildBaseProps

Props for the asChild (polymorphic) rendering of Table Caption.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`TableCaptionProps`type

TableCaptionProps: TableNativeProps<'caption', HTMLTableCaptionElement> | TableCaptionAsChildProps

Props for Table Caption.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLTableCaptionElement | null) => void) | { current: HTMLTableCaptionElement | null; } | null | undefined;

`TableCell`type

TableCell: { (props: TableCellProps): JSX.Element; (props: TableCellAsChildProps): JSX.Element; }

Renders a part of table. Supports polymorphic rendering via asChild.

`TableCellAsChildProps`type

TableCellAsChildProps: TableAsChildBaseProps

Props for the asChild (polymorphic) rendering of Table Cell.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`TableCellProps`type

TableCellProps: TableNativeProps<'td', HTMLTableCellElement> | TableCellAsChildProps

Props for Table Cell.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLTableCellElement | null) => void) | { current: HTMLTableCellElement | null; } | null | undefined;

`TableFoot`type

TableFoot: { (props: TableFootProps): JSX.Element; (props: TableFootAsChildProps): JSX.Element; }

Renders a part of table. Supports polymorphic rendering via asChild.

`TableFootAsChildProps`type

TableFootAsChildProps: TableAsChildBaseProps

Props for the asChild (polymorphic) rendering of Table Foot.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`TableFootProps`type

TableFootProps: TableNativeProps<'tfoot', HTMLTableSectionElement> | TableFootAsChildProps

Props for Table Foot.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLTableSectionElement | null) => void) | { current: HTMLTableSectionElement | null; } | null | undefined;

`TableHead`type

TableHead: { (props: TableHeadProps): JSX.Element; (props: TableHeadAsChildProps): JSX.Element; }

Renders a part of table. Supports polymorphic rendering via asChild.

`TableHeadAsChildProps`type

TableHeadAsChildProps: TableAsChildBaseProps

Props for the asChild (polymorphic) rendering of Table Head.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`TableHeaderCell`type

TableHeaderCell: { (props: TableHeaderCellProps): JSX.Element; (props: TableHeaderCellAsChildProps): JSX.Element; }

Renders a part of table. Supports polymorphic rendering via asChild.

`TableHeaderCellAsChildProps`type

TableHeaderCellAsChildProps: TableAsChildBaseProps

Props for the asChild (polymorphic) rendering of Table Header Cell.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`TableHeaderCellProps`type

TableHeaderCellProps: TableNativeProps<'th', HTMLTableCellElement> | TableHeaderCellAsChildProps

Props for Table Header Cell.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLTableCellElement | null) => void) | { current: HTMLTableCellElement | null; } | null | undefined;

`TableHeadProps`type

TableHeadProps: TableNativeProps<'thead', HTMLTableSectionElement> | TableHeadAsChildProps

Props for Table Head.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLTableSectionElement | null) => void) | { current: HTMLTableSectionElement | null; } | null | undefined;

`TableProps`type

TableProps: TableNativeProps<'table', HTMLTableElement> | TableAsChildBaseProps

Props for Table.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLTableElement | null) => void) | { current: HTMLTableElement | null; } | null | undefined;

`TableRow`type

TableRow: { (props: TableRowProps): JSX.Element; (props: TableRowAsChildProps): JSX.Element; }

Renders a part of table. Supports polymorphic rendering via asChild.

`TableRowAsChildProps`type

TableRowAsChildProps: TableAsChildBaseProps

Props for the asChild (polymorphic) rendering of Table Row.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`TableRowProps`type

TableRowProps: TableNativeProps<'tr', HTMLTableRowElement> | TableRowAsChildProps

Props for Table Row.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLTableRowElement | null) => void) | { current: HTMLTableRowElement | null; } | null | undefined;

`Textarea`type

Textarea: { (props: TextareaElementProps): JSX.Element; (props: TextareaAsChildProps): JSX.Element; }

Renders the textarea part of textarea. Supports polymorphic rendering via asChild.

`TextareaAsChildProps`type

TextareaAsChildProps: TextareaOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<Element>;
}

Props for the asChild (polymorphic) rendering of Textarea.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
ref: ref?: Ref<Element>;
tabIndex: tabIndex?: number | undefined;

`TextareaElementProps`type

TextareaElementProps: Omit<JSX.IntrinsicElements['textarea'], 'children' | 'ref'> & TextareaOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLTextAreaElement>;
}

Props for Textarea Element.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLTextAreaElement>;

`TextareaOwnProps`type

TextareaOwnProps: {
  children?: unknown;
  disabled?: boolean;
  tabIndex?: number;
}

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

children: children?: unknown;
disabled: disabled?: boolean | undefined;
tabIndex: tabIndex?: number | undefined;

`TextareaProps`type

TextareaProps: TextareaElementProps | TextareaAsChildProps

Props for Textarea.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLTextAreaElement | null) => void) | { current: HTMLTextAreaElement | null; } | null | undefined;

`Toast`type

Toast: (props: ToastProps) => JSX.Element | null

Toast registers a notification entry with the host and returns no DOM on its own.

`ToastAction`type

ToastAction: { (props: ToastActionProps): JSX.Element; (props: ToastActionAsChildProps): JSX.Element; }

ToastAction closes the toast after handling a user-triggered action. Renders the toast-action part of toast. Supports polymorphic rendering via asChild.

`ToastActionAsChildProps`type

ToastActionAsChildProps: ButtonLikeAsChildProps

Props for the asChild (polymorphic) rendering of Toast Action.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`ToastActionProps`type

ToastActionProps: ButtonLikeProps<'button', HTMLButtonElement>

Props for Toast Action.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`ToastClose`type

ToastClose: { (props: ToastCloseProps): JSX.Element; (props: ToastCloseAsChildProps): JSX.Element; }

ToastClose is the dedicated dismiss control for a toast entry. Renders the toast-close part of toast. Supports polymorphic rendering via asChild.

`ToastCloseAsChildProps`type

ToastCloseAsChildProps: ButtonLikeAsChildProps

Props for the asChild (polymorphic) rendering of Toast Close.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`ToastCloseProps`type

ToastCloseProps: ButtonLikeProps<'button', HTMLButtonElement>

Props for Toast Close.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`ToastDescription`type

ToastDescription: { (props: ToastDescriptionProps): JSX.Element; (props: ToastDescriptionAsChildProps): JSX.Element; }

ToastDescription marks the accessible description slot for a toast entry. Renders the toast-description part of toast. Supports polymorphic rendering via asChild.

`ToastDescriptionAsChildProps`type

ToastDescriptionAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Toast Description.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`ToastDescriptionProps`type

ToastDescriptionProps: BoxProps<'div', HTMLDivElement>

Props for Toast Description.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`ToastHost`type

ToastHost: (props: ToastHostProps) => JSX.Element

ToastHost owns the registry of active toast entries and the default display duration for the family.

`ToastHostOwnProps`type

ToastHostOwnProps: {
  children?: unknown;
  id?: string;
  duration?: number;
}

Props for the host that owns toast timing defaults and the registry.

children: children?: unknown;
duration: duration?: number | undefined;
id: id?: string | undefined;

`ToastHostProps`type

ToastHostProps: BoxProps<'div', HTMLDivElement> & ToastHostOwnProps

Props for Toast Host.

asChild: asChild?: false | undefined;
children: children?: unknown;
duration: duration?: number | undefined;
id: id?: string | undefined;
ref: ref?: Ref<HTMLDivElement>;

`ToastOwnProps`type

ToastOwnProps: {
  children?: unknown;
  id?: string;
  open?: boolean;
  defaultOpen?: boolean;
  onOpenChange?: (open: boolean) => void;
  duration?: number;
  variant?: ToastVariant;
}

Props for a toast registration entry declared through Toast.

children: children?: unknown;
defaultOpen: defaultOpen?: boolean | undefined;
duration: duration?: number | undefined;
id: id?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;
variant: variant?: ToastVariant | undefined;

`ToastProps`type

ToastProps: BoxProps<'div', HTMLDivElement> & ToastOwnProps

Props for Toast.

asChild: asChild?: false | undefined;
children: children?: unknown;
defaultOpen: defaultOpen?: boolean | undefined;
duration: duration?: number | undefined;
id: id?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;
variant: variant?: ToastVariant | undefined;

`ToastTitle`type

ToastTitle: { (props: ToastTitleProps): JSX.Element; (props: ToastTitleAsChildProps): JSX.Element; }

ToastTitle marks the accessible title slot for a toast entry. Renders the toast-title part of toast. Supports polymorphic rendering via asChild.

`ToastTitleAsChildProps`type

ToastTitleAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Toast Title.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`ToastTitleProps`type

ToastTitleProps: BoxProps<'div', HTMLDivElement>

Props for Toast Title.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`ToastViewport`type

ToastViewport: { (props: ToastViewportProps): JSX.Element; (props: ToastViewportAsChildProps): JSX.Element; }

ToastViewport renders the live toast stack and the notification region. Renders the toast-viewport part of toast with role="region". Supports polymorphic rendering via asChild.

`ToastViewportAsChildProps`type

ToastViewportAsChildProps: BoxAsChildProps

Props for the asChild (polymorphic) rendering of Toast Viewport.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`ToastViewportProps`type

ToastViewportProps: BoxProps<'div', HTMLDivElement>

Props for Toast Viewport.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLDivElement>;

`Toggle`type

Toggle: { (props: ToggleButtonProps): JSX.Element; (props: ToggleAsChildProps): JSX.Element; }

Headless Toggle component ## Responsibilities - Compose pressable foundation for interaction behavior - Apply aria-pressed for toggle state signaling - Enforce type="button" default to prevent accidental form submission - Forward props and refs to native button or child element ## Non-Responsibilities (delegated to pressable foundation) - Keyboard event handling (Enter/Space) - Pointer event handling - Disabled state enforcement - Role attribute application (for non-native elements) ## Invariants - MUST NOT contain any event handler logic - MUST NOT check disabled or pressed props directly - MUST use pressable() for ALL interaction behavior - MUST use mergeProps() for ALL prop composition - pressed state is CONTROLLED (consumer manages state) Renders the toggle part of toggle. Supports polymorphic rendering via asChild.

Native toggle button
```tsx
const pressed = state(false);
<Toggle pressed={pressed()} onPress={() => pressed.set(!pressed())}>
Mute
</Toggle>
```

Polymorphic rendering (asChild)
```tsx
<Toggle asChild pressed={muted} onPress={toggleMute}>
<span>Ã°Å¸â€â€¡</span>
</Toggle>
```

`ToggleAsChildProps`type

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

Props when rendering via asChild

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((e: PressEvent) => void) | undefined;
pressed: pressed?: boolean | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`ToggleButtonProps`type

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

Props when rendering as a native <button> element

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((e: PressEvent) => void) | undefined;
pressed: pressed?: boolean | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`ToggleGroup`type

ToggleGroup: (props: ToggleGroupProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders a part of toggle-group.

`ToggleGroupItem`type

ToggleGroupItem: { (props: ToggleGroupItemProps): JSX.Element; (props: ToggleGroupItemAsChildProps): JSX.Element; }

Renders a part of toggle-group. Supports polymorphic rendering via asChild.

`ToggleGroupItemAsChildProps`type

ToggleGroupItemAsChildProps: ButtonLikeAsChildProps & ToggleGroupItemOwnProps

Props for the asChild (polymorphic) rendering of Toggle Group Item.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;
value: value: string;

`ToggleGroupItemOwnProps`type

ToggleGroupItemOwnProps: {
  value: string;
  disabled?: boolean;
  children?: unknown;
}

Own props for Toggle Group Item, before merging with native element attributes.

children: children?: unknown;
disabled: disabled?: boolean | undefined;
value: value: string;

`ToggleGroupItemProps`type

ToggleGroupItemProps: ButtonLikeProps<'button', HTMLButtonElement> & ToggleGroupItemOwnProps

Props for Toggle Group Item.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`ToggleGroupMultipleProps`type

ToggleGroupMultipleProps: BoxProps<'div', HTMLDivElement> & ToggleGroupSharedOwnProps & {
  type: 'multiple';
  value?: string[];
  defaultValue?: string[];
  onValueChange?: (value: string[]) => void;
}

Props for Toggle Group Multiple.

asChild: asChild?: false | undefined;
children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultValue: defaultValue?: string[] | undefined;
disabled: disabled?: boolean | undefined;
id: id?: string | undefined;
loop: loop?: boolean | undefined;
onValueChange: onValueChange?: ((value: string[]) => void) | undefined;
orientation: orientation?: ToggleGroupOrientation | undefined;
ref: ref?: Ref<HTMLDivElement>;
type: type: "multiple";
value: value?: string[] | undefined;

`ToggleGroupOrientation`type

ToggleGroupOrientation: 'horizontal' | 'vertical'

Toggle Group Orientation.

`ToggleGroupProps`type

ToggleGroupProps: ToggleGroupSingleProps | ToggleGroupMultipleProps

Props for Toggle Group.

asChild: asChild?: false | undefined;
children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultValue: defaultValue?: string | string[] | undefined;
disabled: disabled?: boolean | undefined;
id: id?: string | undefined;
loop: loop?: boolean | undefined;
onValueChange: onValueChange?: ((value: string[]) => void) | ((value: string) => void) | undefined;
orientation: orientation?: ToggleGroupOrientation | undefined;
ref: ref?: Ref<HTMLDivElement>;
type: type?: "single" | "multiple" | undefined;
value: value?: string | string[] | undefined;

`ToggleGroupSingleProps`type

ToggleGroupSingleProps: BoxProps<'div', HTMLDivElement> & ToggleGroupSharedOwnProps & {
  type?: 'single';
  value?: string;
  defaultValue?: string;
  onValueChange?: (value: string) => void;
}

Props for Toggle Group Single.

asChild: asChild?: false | undefined;
children: Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultValue: defaultValue?: string | undefined;
disabled: disabled?: boolean | undefined;
id: id?: string | undefined;
loop: loop?: boolean | undefined;
onValueChange: onValueChange?: ((value: string) => void) | undefined;
orientation: orientation?: ToggleGroupOrientation | undefined;
ref: ref?: Ref<HTMLDivElement>;
type: type?: "single" | undefined;
value: value?: string | undefined;

`ToggleOwnProps`type

ToggleOwnProps: {
  children?: unknown;
  onPress?: (e: PressEvent) => void;
  pressed?: boolean;
  disabled?: boolean;
}

Props shared by all Toggle variants

children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((e: PressEvent) => void) | undefined;
pressed: pressed?: boolean | undefined;

`ToggleProps`type

ToggleProps: ToggleButtonProps | ToggleAsChildProps

Discriminated union of Toggle prop types

asChild: asChild?: boolean | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((e: PressEvent) => void) | undefined;
pressed: pressed?: boolean | undefined;
ref: ref?: ((value: Element | null) => void) | { current: Element | null; } | ((value: HTMLButtonElement | null) => void) | { current: HTMLButtonElement | null; } | null | undefined;
type: type?: "button" | "submit" | "reset" | undefined;

`Tooltip`type

Tooltip: (props: TooltipProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders a part of tooltip.

`TooltipContent`type

TooltipContent: { (props: TooltipContentProps): JSX.Element | null; (props: TooltipContentAsChildProps): JSX.Element | null; }

Renders the tooltip-content part of tooltip with role="tooltip". Supports polymorphic rendering via asChild.

`TooltipContentAsChildProps`type

TooltipContentAsChildProps: BoxAsChildProps & TooltipContentOwnProps

Props for the asChild (polymorphic) rendering of Tooltip Content.

align: align?: OverlayAlign | undefined;
asChild: asChild: true;
children: children: JSXElement;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<Element>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`TooltipContentOwnProps`type

TooltipContentOwnProps: {
  forceMount?: boolean;
  side?: OverlaySide;
  align?: OverlayAlign;
  sideOffset?: number;
}

Own props for Tooltip Content, before merging with native element attributes.

align: align?: OverlayAlign | undefined;
forceMount: forceMount?: boolean | undefined;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`TooltipContentProps`type

TooltipContentProps: BoxProps<'div', HTMLDivElement> & TooltipContentOwnProps

Props for Tooltip Content.

align: align?: OverlayAlign | undefined;
asChild: asChild?: false | undefined;
children: children?: unknown;
forceMount: forceMount?: boolean | undefined;
ref: ref?: Ref<HTMLDivElement>;
side: side?: OverlaySide | undefined;
sideOffset: sideOffset?: number | undefined;

`TooltipOwnProps`type

TooltipOwnProps: {
  children?: unknown;
  id?: string;
  open?: boolean;
  defaultOpen?: boolean;
  onOpenChange?: (open: boolean) => void;
}

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

children: children?: unknown;
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;

`TooltipPortal`type

TooltipPortal: (props: TooltipPortalProps) => JSX.Element | null

Renders a part of tooltip.

`TooltipPortalProps`type

TooltipPortalProps: {
  children?: unknown;
}

Props for Tooltip Portal.

children: children?: unknown;

`TooltipProps`type

TooltipProps: TooltipOwnProps

Props for Tooltip.

children: children?: unknown;
defaultOpen: defaultOpen?: boolean | undefined;
id: id?: string | undefined;
onOpenChange: onOpenChange?: ((open: boolean) => void) | undefined;
open: open?: boolean | undefined;

`TooltipTrigger`type

TooltipTrigger: { (props: TooltipTriggerProps): JSX.Element; (props: TooltipTriggerAsChildProps): JSX.Element; }

Renders the tooltip-trigger part of tooltip. Supports polymorphic rendering via asChild.

`TooltipTriggerAsChildProps`type

TooltipTriggerAsChildProps: ButtonLikeAsChildProps

Props for the asChild (polymorphic) rendering of Tooltip Trigger.

asChild: asChild: true;
children: children: JSXElement;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<Element>;
type: type?: undefined;

`TooltipTriggerProps`type

TooltipTriggerProps: ButtonLikeProps<'button', HTMLButtonElement>

Props for Tooltip Trigger.

asChild: asChild?: false | undefined;
children: children?: unknown;
disabled: disabled?: boolean | undefined;
onPress: onPress?: ((event: PressEvent) => void) | undefined;
ref: ref?: Ref<HTMLButtonElement>;
type: type?: "button" | "submit" | "reset" | undefined;

`VirtualList`type

VirtualList: { <Item>(props: VirtualListProps<Item>): JSX.Element; <Item>(props: VirtualListAsChildProps<Item>): JSX.Element; }

Renders a part of virtual-list. Supports polymorphic rendering via asChild.

`VirtualListApi`type

VirtualListApi: {
  scrollToIndex: (index: number, alignment?: VirtualScrollAlignment) => void;
  scrollToTop: () => void;
  scrollToBottom: () => void;
  getState: () => VirtualListState;
  getVisibleRange: () => VirtualRange;
  getItemCount: () => number;
  getScrollTop: () => number;
  isAtTop: () => boolean;
  isAtBottom: () => boolean;
  isFollowingBottom: () => boolean;
  getPendingUnseenCount: () => number;
  setFollowBottom: (followBottom: boolean) => void;
}

Virtual List Api.

`VirtualListAsChildProps`type

VirtualListAsChildProps: Omit<VirtualListRootProps, 'children'> & {
  items: readonly Item[];
  rowHeight: number;
  /** Optional keyed row sizing. When omitted, VirtualList retains its fixed-height arithmetic path. */
  getRowHeight?: (item: Item, index: number) => number;
  overscan?: VirtualOverscan;
  getKey: (item: Item, index: number) => string | number;
  rowComponent: VirtualListRowComponent<Item>;
  followBottom?: boolean | {
    threshold?: number;
  };
  onScroll?: (event: Event) => void;
  viewport?: VirtualListViewport;
  apiRef?: Ref<VirtualListApi<Item> | null>;
  ref?: Ref<HTMLElement>;
  asChild: true;
  children: JSXElement;
}

Props for the asChild (polymorphic) rendering of Virtual List.

apiRef: apiRef?: Ref<VirtualListApi<Item> | null>;
asChild: asChild: true;
children: children: JSXElement;
followBottom: followBottom?: boolean | { threshold?: number; } | undefined;
getKey: getKey: (item: Item, index: number) => string | number;
getRowHeight: Optional keyed row sizing. When omitted, VirtualList retains its fixed-height arithmetic path.
items: items: readonly Item[];
onScroll: onScroll?: ((event: Event) => void) | undefined;
overscan: overscan?: VirtualOverscan | undefined;
ref: ref?: Ref<HTMLElement>;
rowComponent: rowComponent: VirtualListRowComponent<Item>;
rowHeight: rowHeight: number;
viewport: viewport?: "lg" | undefined;

`VirtualListProps`type

VirtualListProps: VirtualListRootProps & {
  items: readonly Item[];
  rowHeight: number;
  /** Optional keyed row sizing. When omitted, VirtualList retains its fixed-height arithmetic path. */
  getRowHeight?: (item: Item, index: number) => number;
  overscan?: VirtualOverscan;
  getKey: (item: Item, index: number) => string | number;
  rowComponent: VirtualListRowComponent<Item>;
  followBottom?: boolean | {
    threshold?: number;
  };
  onScroll?: (event: Event) => void;
  viewport?: VirtualListViewport;
  apiRef?: Ref<VirtualListApi<Item> | null>;
  ref?: Ref<HTMLElement>;
  asChild?: false;
}

Props for Virtual List.

apiRef: apiRef?: Ref<VirtualListApi<Item> | null>;
asChild: asChild?: false | undefined;
followBottom: followBottom?: boolean | { threshold?: number; } | undefined;
getKey: getKey: (item: Item, index: number) => string | number;
getRowHeight: Optional keyed row sizing. When omitted, VirtualList retains its fixed-height arithmetic path.
items: items: readonly Item[];
onScroll: onScroll?: ((event: Event) => void) | undefined;
overscan: overscan?: VirtualOverscan | undefined;
ref: ref?: Ref<HTMLElement>;
rowComponent: rowComponent: VirtualListRowComponent<Item>;
rowHeight: rowHeight: number;
viewport: viewport?: "lg" | undefined;

`VirtualListRowComponent`type

VirtualListRowComponent: (props: VirtualListRowComponentProps<Item>) => VirtualListRowElement | null

Virtual List Row Component.

`VirtualListRowComponentProps`type

VirtualListRowComponentProps: {
  item: Item;
  index: number;
  rowKey: string;
  isVisible: boolean;
}

Props for Virtual List Row Component.

index: index: number;
isVisible: isVisible: boolean;
item: item: Item;
rowKey: rowKey: string;

`VirtualListRowElement`type

VirtualListRowElement: JSXElement | JSX.Element

Virtual List Row Element.

`VirtualListState`type

VirtualListState: {
  count: number;
  scrollTop: number;
  viewportHeight: number;
  totalHeight: number;
  visibleRange: VirtualRange;
  isAtTop: boolean;
  isAtBottom: boolean;
  followBottom: boolean;
  pendingUnseenCount: number;
}

Virtual List State.

`VirtualListViewport`type

VirtualListViewport: 'lg'

Virtual List Viewport.

`VirtualTable`type

VirtualTable: { <Row>(props: VirtualTableProps<Row>): JSX.Element; <Row>(props: VirtualTableAsChildProps<Row>): JSX.Element; }

Renders a part of virtual-table. Supports polymorphic rendering via asChild.

`VirtualTableApi`type

VirtualTableApi: {
  scrollToIndex: (index: number, alignment?: VirtualScrollAlignment) => void;
  scrollToTop: () => void;
  scrollToBottom: () => void;
  getState: () => VirtualTableState;
  getVisibleRange: () => VirtualRange;
  getRowCount: () => number;
  getScrollTop: () => number;
  isAtTop: () => boolean;
  isAtBottom: () => boolean;
  getSelectedRowKey: () => string | null;
  getSelectedRowIndex: () => number;
  selectRowByKey: (rowKey: string) => void;
  selectRowByIndex: (index: number) => void;
  clearSelection: () => void;
}

Virtual Table Api.

`VirtualTableAsChildProps`type

VirtualTableAsChildProps: Omit<VirtualTableRootProps, 'children'> & {
  rows: readonly Row[];
  rowHeight: number;
  headerHeight: number;
  overscan?: VirtualOverscan;
  getKey: (row: Row, index: number) => string | number;
  columns: readonly VirtualTableColumn<Row>[];
  selectedRowKey?: string | null;
  defaultSelectedRowKey?: string | null;
  onSelectedRowKeyChange?: (next: string | null) => void;
  onRowClick?: (row: Row, rowIndex: number, rowKey: string, event: MouseEvent) => void;
  onScroll?: (event: Event) => void;
  viewport?: VirtualTableViewport;
  tableWidth?: VirtualTableWidth;
  apiRef?: Ref<VirtualTableApi<Row> | null>;
  ref?: Ref<HTMLElement>;
  asChild: true;
  children: JSXElement;
}

Props for the asChild (polymorphic) rendering of Virtual Table.

apiRef: apiRef?: Ref<VirtualTableApi<Row> | null>;
asChild: asChild: true;
children: children: JSXElement;
columns: columns: readonly VirtualTableColumn<Row>[];
defaultSelectedRowKey: defaultSelectedRowKey?: string | null | undefined;
getKey: getKey: (row: Row, index: number) => string | number;
headerHeight: headerHeight: number;
onRowClick: onRowClick?: ((row: Row, rowIndex: number, rowKey: string, event: MouseEvent) => void) | undefined;
onScroll: onScroll?: ((event: Event) => void) | undefined;
onSelectedRowKeyChange: onSelectedRowKeyChange?: ((next: string | null) => void) | undefined;
overscan: overscan?: VirtualOverscan | undefined;
ref: ref?: Ref<HTMLElement>;
rowHeight: rowHeight: number;
rows: rows: readonly Row[];
selectedRowKey: selectedRowKey?: string | null | undefined;
tableWidth: tableWidth?: "compact" | undefined;
viewport: viewport?: "lg" | undefined;

`VirtualTableCellComponent`type

VirtualTableCellComponent: (props: VirtualTableCellComponentProps<Row>) => VirtualTableCellElement | null

Virtual Table Cell Component.

`VirtualTableCellComponentProps`type

VirtualTableCellComponentProps: {
  row: Row;
  rowIndex: number;
  rowKey: string;
  column: VirtualTableColumn<Row>;
  selected: boolean;
}

Props for Virtual Table Cell Component.

column: column: VirtualTableColumn<Row>;
row: row: Row;
rowIndex: rowIndex: number;
rowKey: rowKey: string;
selected: selected: boolean;

`VirtualTableCellElement`type

VirtualTableCellElement: JSXElement | JSX.Element

Virtual Table Cell Element.

`VirtualTableColumn`type

VirtualTableColumn: {
  id: string;
  header: JSXElement | string;
  width?: number | string;
  cellComponent: VirtualTableCellComponent<Row>;
}

Virtual Table Column.

`VirtualTableProps`type

VirtualTableProps: VirtualTableRootProps & {
  rows: readonly Row[];
  rowHeight: number;
  headerHeight: number;
  overscan?: VirtualOverscan;
  getKey: (row: Row, index: number) => string | number;
  columns: readonly VirtualTableColumn<Row>[];
  selectedRowKey?: string | null;
  defaultSelectedRowKey?: string | null;
  onSelectedRowKeyChange?: (next: string | null) => void;
  onRowClick?: (row: Row, rowIndex: number, rowKey: string, event: MouseEvent) => void;
  onScroll?: (event: Event) => void;
  viewport?: VirtualTableViewport;
  tableWidth?: VirtualTableWidth;
  apiRef?: Ref<VirtualTableApi<Row> | null>;
  ref?: Ref<HTMLElement>;
  asChild?: false;
}

Props for Virtual Table.

apiRef: apiRef?: Ref<VirtualTableApi<Row> | null>;
asChild: asChild?: false | undefined;
columns: columns: readonly VirtualTableColumn<Row>[];
defaultSelectedRowKey: defaultSelectedRowKey?: string | null | undefined;
getKey: getKey: (row: Row, index: number) => string | number;
headerHeight: headerHeight: number;
onRowClick: onRowClick?: ((row: Row, rowIndex: number, rowKey: string, event: MouseEvent) => void) | undefined;
onScroll: onScroll?: ((event: Event) => void) | undefined;
onSelectedRowKeyChange: onSelectedRowKeyChange?: ((next: string | null) => void) | undefined;
overscan: overscan?: VirtualOverscan | undefined;
ref: ref?: Ref<HTMLElement>;
rowHeight: rowHeight: number;
rows: rows: readonly Row[];
selectedRowKey: selectedRowKey?: string | null | undefined;
tableWidth: tableWidth?: "compact" | undefined;
viewport: viewport?: "lg" | undefined;

`VirtualTableState`type

VirtualTableState: {
  count: number;
  rowHeight: number;
  headerHeight: number;
  scrollTop: number;
  viewportHeight: number;
  totalHeight: number;
  visibleRange: VirtualRange;
  isAtTop: boolean;
  isAtBottom: boolean;
  selectedRowKey: string | null;
  selectedRowIndex: number;
}

Virtual Table State.

`VirtualTableViewport`type

VirtualTableViewport: 'lg'

Virtual Table Viewport.

`VirtualTableWidth`type

VirtualTableWidth: 'compact'

Virtual Table Width.

`VisuallyHidden`type

VisuallyHidden: { (props: VisuallyHiddenSpanProps): JSX.Element; (props: VisuallyHiddenAsChildProps): JSX.Element; }

Renders a part of visually-hidden. Supports polymorphic rendering via asChild.

`VisuallyHiddenAsChildProps`type

VisuallyHiddenAsChildProps: VisuallyHiddenOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<Element>;
}

Props for the asChild (polymorphic) rendering of Visually Hidden.

asChild: asChild: true;
children: children: JSXElement;
ref: ref?: Ref<Element>;

`VisuallyHiddenOwnProps`type

VisuallyHiddenOwnProps: {
  children?: unknown;
}

Own props for Visually Hidden, before merging with native element attributes.

children: children?: unknown;

`VisuallyHiddenProps`type

VisuallyHiddenProps: VisuallyHiddenSpanProps | VisuallyHiddenAsChildProps

Props for Visually Hidden.

asChild: asChild?: boolean | undefined;
children: children?: unknown;
ref: ref?: ((value: HTMLSpanElement | null) => void) | { current: HTMLSpanElement | null; } | ((value: Element | null) => void) | { current: Element | null; } | null | undefined;

`VisuallyHiddenSpanProps`type

VisuallyHiddenSpanProps: Omit<JSX.IntrinsicElements['span'], 'children' | 'ref'> & VisuallyHiddenOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLSpanElement>;
}

Props for Visually Hidden Span.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLSpanElement>;

Exports

Accordiontype

AccordionContenttype

AccordionContentAsChildPropstype

AccordionContentOwnPropstype

AccordionContentPropstype

AccordionHeadertype

AccordionHeaderAsChildPropstype

AccordionHeaderPropstype

AccordionItemtype

AccordionItemOwnPropstype

AccordionItemPropstype

AccordionMultiplePropstype

AccordionOrientationtype

AccordionPropstype

AccordionSinglePropstype

AccordionTriggertype

AccordionTriggerAsChildPropstype

AccordionTriggerPropstype

AlertDialogtype

AlertDialogActiontype

AlertDialogActionAsChildPropstype

AlertDialogActionPropstype

AlertDialogCanceltype

AlertDialogCancelAsChildPropstype

AlertDialogCancelPropstype

AlertDialogContenttype

AlertDialogContentAsChildPropstype

AlertDialogContentOwnPropstype

AlertDialogContentPropstype

AlertDialogDescriptiontype

AlertDialogDescriptionAsChildPropstype

AlertDialogDescriptionPropstype

AlertDialogOverlaytype

AlertDialogOverlayAsChildPropstype

AlertDialogOverlayOwnPropstype

AlertDialogOverlayPropstype

AlertDialogOwnPropstype

AlertDialogPortaltype

AlertDialogPortalPropstype

AlertDialogPropstype

AlertDialogTitletype

AlertDialogTitleAsChildPropstype

AlertDialogTitlePropstype

AlertDialogTriggertype

AlertDialogTriggerAsChildPropstype

AlertDialogTriggerPropstype

Avatartype

AvatarAsChildPropstype

AvatarFallbacktype

AvatarFallbackAsChildPropstype

AvatarFallbackOwnPropstype

AvatarFallbackPropstype

AvatarImagetype

AvatarImageOwnPropstype

AvatarImagePropstype

AvatarLoadingStatustype

AvatarOwnPropstype

AvatarPropstype

Buttontype

ButtonAsChildElementtype

ButtonAsChildPropstype

ButtonNativePropstype

ButtonOwnPropstype

ButtonPropstype

ButtonSizetype

ButtonVarianttype

ButtonWidthtype

Checkboxtype

CheckboxAsChildPropstype

CheckboxInputPropstype

CheckboxOwnPropstype

CheckboxPropstype

Collapsibletype

CollapsibleContenttype

CollapsibleContentAsChildPropstype

CollapsibleContentPropstype

CollapsiblePropstype

CollapsibleTriggertype

CollapsibleTriggerAsChildPropstype

`Accordion`type

`AccordionContent`type

`AccordionContentAsChildProps`type

`AccordionContentOwnProps`type

`AccordionContentProps`type

`AccordionHeader`type

`AccordionHeaderAsChildProps`type

`AccordionHeaderProps`type

`AccordionItem`type

`AccordionItemOwnProps`type

`AccordionItemProps`type

`AccordionMultipleProps`type

`AccordionOrientation`type

`AccordionProps`type

`AccordionSingleProps`type

`AccordionTrigger`type

`AccordionTriggerAsChildProps`type

`AccordionTriggerProps`type

`AlertDialog`type

`AlertDialogAction`type

`AlertDialogActionAsChildProps`type

`AlertDialogActionProps`type

`AlertDialogCancel`type

`AlertDialogCancelAsChildProps`type

`AlertDialogCancelProps`type

`AlertDialogContent`type

`AlertDialogContentAsChildProps`type

`AlertDialogContentOwnProps`type

`AlertDialogContentProps`type

`AlertDialogDescription`type

`AlertDialogDescriptionAsChildProps`type

`AlertDialogDescriptionProps`type

`AlertDialogOverlay`type

`AlertDialogOverlayAsChildProps`type

`AlertDialogOverlayOwnProps`type

`AlertDialogOverlayProps`type

`AlertDialogOwnProps`type

`AlertDialogPortal`type

`AlertDialogPortalProps`type

`AlertDialogProps`type

`AlertDialogTitle`type

`AlertDialogTitleAsChildProps`type

`AlertDialogTitleProps`type

`AlertDialogTrigger`type

`AlertDialogTriggerAsChildProps`type

`AlertDialogTriggerProps`type

`Avatar`type

`AvatarAsChildProps`type

`AvatarFallback`type

`AvatarFallbackAsChildProps`type

`AvatarFallbackOwnProps`type

`AvatarFallbackProps`type

`AvatarImage`type

`AvatarImageOwnProps`type

`AvatarImageProps`type

`AvatarLoadingStatus`type

`AvatarOwnProps`type

`AvatarProps`type

`Button`type

`ButtonAsChildElement`type

`ButtonAsChildProps`type

`ButtonNativeProps`type

`ButtonOwnProps`type

`ButtonProps`type

`ButtonSize`type

`ButtonVariant`type

`ButtonWidth`type

`Checkbox`type

`CheckboxAsChildProps`type

`CheckboxInputProps`type

`CheckboxOwnProps`type

`CheckboxProps`type

`Collapsible`type

`CollapsibleContent`type

`CollapsibleContentAsChildProps`type

`CollapsibleContentProps`type

`CollapsibleProps`type

`CollapsibleTrigger`type

`CollapsibleTriggerAsChildProps`type

`CollapsibleTriggerProps`type