Search documentation

Search by topic, API name, or import path.

GitHub ↗

Module / v1.0.0-beta.7

@typed/ui/Menu

26 unique exports available through this public import path, including their members and aliases.

Learn this UI primitive →

import * as Menu from "@typed/ui/Menu";

Checked commands

  • CheckboxItem

    function

    Renders Item with menuitemcheckbox semantics and caller-supplied checked state.

  • CheckboxItemOptions

    interface

    Inputs accepted by Menu.CheckboxItem in addition to the shared DOM host options.

  • RadioItem

    function

    Renders Item with menuitemradio semantics and caller-supplied checked state.

  • RadioItemOptions

    interface

    Inputs accepted by Menu.RadioItem in addition to the shared DOM host options.

Command grouping

  • Group

    function

    Renders a labelled ARIA group inside menu content.

  • GroupOptions

    interface

    Inputs accepted by Menu.Group in addition to the shared DOM host options.

  • Separator

    function

    Renders a separator with explicit horizontal or vertical orientation.

  • SeparatorOptions

    interface

    Inputs accepted by Menu.Separator in addition to the shared DOM host options.

Command registration

Commands

  • Dismiss

    variable

    Consumer-facing alias of the canonical Menu component with identical behavior and lifetime.

  • Item

    function

    Renders and optionally registers a menu item; disabled items remain announced but do not activate.

  • ItemOptions

    interface

    Inputs accepted by Menu.Item in addition to the shared DOM host options.

Menu surface

  • Content

    function

    Renders manual-popover menu content and coordinates focus, typeahead, Escape, and nested-menu traversal.

  • ContentOptions

    interface

    Inputs accepted by Menu.Content in addition to the shared DOM host options.

  • Menu

    variable

    Consumer-facing alias of the canonical Menu component with identical behavior and lifetime.

Nested menus

  • ParentMenu

    interface

    Public Menu.ParentMenu behavioral model.

  • SubmenuTrigger

    function

    Renders a menuitem that targets nested popover content and coordinates parent/child directional focus.

  • SubmenuTriggerOptions

    interface

    Inputs accepted by Menu.SubmenuTrigger in addition to the shared DOM host options.

Opening a menu

  • Button

    variable

    Consumer-facing alias of the canonical Menu component with identical behavior and lifetime.

  • Trigger

    function

    Renders a native button targeting menu popover content and opens the menu on ArrowDown.

  • TriggerOptions

    interface

    Inputs accepted by Menu.Trigger in addition to the shared DOM host options.

Popup state

  • InitialState

    interface

    Initial Menu values. The caller supplies id; open defaults false, activeId null, loop true, and orientation vertical.

  • State

    interface

    Popup identity, visibility, and active command focus. Checked preferences and command results belong to the application, not this state.

  • StateSchema

    variable

    Effect Schema used by makeState to encode, decode, and hydrate Menu state.

  • makeState

    function

    Creates hydrated Menu state. The caller supplies id; open defaults false, activeId null, loop true, and orientation vertical.

  • setOpen

    function

    Updates only the menu’s explicit open state.