Generated API snapshot

@askrjs/ui/dropdown

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

Exports

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

`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.

Exports

Dropdowntype

DropdownContenttype

DropdownContentAsChildPropstype

DropdownContentOwnPropstype

DropdownContentPropstype

DropdownGrouptype

DropdownGroupAsChildPropstype

DropdownGroupPropstype

DropdownItemtype

DropdownItemAsChildPropstype

DropdownItemOwnPropstype

DropdownItemPropstype

DropdownItemVarianttype

DropdownLabeltype

DropdownLabelAsChildPropstype

DropdownLabelPropstype

DropdownOwnPropstype

DropdownPortaltype

DropdownPortalPropstype

DropdownPropstype

DropdownSeparatortype

DropdownSeparatorAsChildPropstype

DropdownSeparatorPropstype

DropdownTriggertype

DropdownTriggerAsChildPropstype

DropdownTriggerOwnPropstype

DropdownTriggerPropstype

DropdownTriggerSizetype

DropdownTriggerVarianttype