Generated API snapshot

@askrjs/ui/menubar

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

Exports

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

`Menubar`type

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

Renders a part of `menubar`.

`MENUBAR_A11Y_CONTRACT`type

MENUBAR_A11Y_CONTRACT: { readonly ROOT_ROLE: "menubar"; readonly CONTENT_ROLE: "menu"; readonly ITEM_ROLE: "menuitem"; readonly EXPANDED_ATTRIBUTE: "aria-expanded"; readonly HAS_POPUP_ATTRIBUTE: "aria-haspopup"; readonly DATA_ATTRIBUTES: { readonly slot: "data-slot"; readonly state: "data-state"; readonly disabled: "data-disabled"; readonly side: "data-side"; readonly align: "data-align"; }; }

WAI-ARIA menubar contract.

`MenubarA11yContract`type

MenubarA11yContract: typeof MENUBAR_A11Y_CONTRACT

Type of the Menubar A11y Contract object.

`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) => 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) => 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) => 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;

Exports

Menubartype

MENUBAR_A11Y_CONTRACTtype

MenubarA11yContracttype

MenubarContenttype

MenubarContentAsChildPropstype

MenubarContentOwnPropstype

MenubarContentPropstype

MenubarGrouptype

MenubarGroupAsChildPropstype

MenubarGroupPropstype

MenubarItemtype

MenubarItemAsChildPropstype

MenubarItemPropstype

MenubarLabeltype

MenubarLabelAsChildPropstype

MenubarLabelPropstype

MenubarMenutype

MenubarMenuPropstype

MenubarOwnPropstype

MenubarPortaltype

MenubarPortalPropstype

MenubarPropstype

MenubarSeparatortype

MenubarSeparatorAsChildPropstype

MenubarSeparatorPropstype

MenubarSubtype

MenubarSubContenttype

MenubarSubContentAsChildPropstype

MenubarSubContentPropstype

MenubarSubPropstype

MenubarSubTriggertype

MenubarSubTriggerAsChildPropstype

MenubarSubTriggerPropstype

MenubarTriggertype

MenubarTriggerAsChildPropstype

MenubarTriggerPropstype

`Menubar`type

`MENUBAR_A11Y_CONTRACT`type

`MenubarA11yContract`type

`MenubarContent`type

`MenubarContentAsChildProps`type

`MenubarContentOwnProps`type

`MenubarContentProps`type

`MenubarGroup`type

`MenubarGroupAsChildProps`type

`MenubarGroupProps`type

`MenubarItem`type

`MenubarItemAsChildProps`type

`MenubarItemProps`type

`MenubarLabel`type

`MenubarLabelAsChildProps`type

`MenubarLabelProps`type

`MenubarMenu`type

`MenubarMenuProps`type

`MenubarOwnProps`type

`MenubarPortal`type

`MenubarPortalProps`type

`MenubarProps`type

`MenubarSeparator`type

`MenubarSeparatorAsChildProps`type

`MenubarSeparatorProps`type

`MenubarSub`type

`MenubarSubContent`type

`MenubarSubContentAsChildProps`type

`MenubarSubContentProps`type

`MenubarSubProps`type

`MenubarSubTrigger`type

`MenubarSubTriggerAsChildProps`type

`MenubarSubTriggerProps`type

`MenubarTrigger`type

`MenubarTriggerAsChildProps`type

`MenubarTriggerProps`type