@box-kite/react 2.2.15 → 2.2.17

package/components/menu.d.ts

@@ -138,77 +138,6 @@ export interface MenuSubProps<TKey extends keyof ComponentsAndVariants = 'menu'>
     /** Attributes for the item that opens it — the submenu's own go in `props`. */
     itemProps?: React.ButtonHTMLAttributes<HTMLButtonElement>;
 }
-/**
- * A menu button and its menu, on the platform's own Popover API: `<Menu>` is the button's menu, and every
- * `Menu.Sub` inside it is another popover nested in that one.
- *
- * ```tsx
- * <Menu trigger={(t) => <Button {...t}>Actions</Button>}>
- *   <Menu.Item onSelect={duplicate}>Duplicate</Menu.Item>
- *   <Menu.Item disabled>Move</Menu.Item>
- *   <Menu.Separator />
- *   <Menu.CheckboxItem checked={compact} onCheckedChange={setCompact}>Compact rows</Menu.CheckboxItem>
- *   <Menu.Sub label="Share">
- *     <Menu.Item onSelect={copyLink}>Copy link</Menu.Item>
- *   </Menu.Sub>
- * </Menu>
- * ```
- *
- * **What the platform owns**, measured in Chrome 152: the top layer, so the menu paints over every
- * stacking context and outside every clipped ancestor with no portal and no `z-index`; light dismiss, so
- * Escape and a press outside close it — Escape closing the innermost submenu first, one layer per press;
- * the toggle from the trigger, including the press that closes an open menu from its own button; and
- * focus return to whatever had focus before the menu opened. A submenu is a popover nested inside its
- * menu, so opening one leaves its parent open, and closing the menu closes every submenu with it.
- *
- * **What is written here** is the ARIA, the arrow keys, typeahead, and the focus the platform does not
- * move: into the first item on open, and back onto a submenu's own item when that submenu closes — the
- * platform returns focus for the outermost layer only.
- *
- * **The menu is always rendered**, and closed means `display: none`, which is what lets the browser own
- * show and hide; the exit is therefore a CSS transition rather than a `<Presence>`. A menu whose items are
- * expensive should be gated by the consumer: `{open && <Items />}`.
- *
- * **The menu keeps the side it chose when it opened**, since Chrome never re-evaluates
- * `position-try-fallbacks` for an element in the top layer (measured in 152) — so a menu left open while
- * the page scrolls does not flip. Every open picks the right side.
- *
- * Where the browser has no Popover API each layer is an `Overlay` — a portal — with `useDismiss` and
- * `useFocusReturn` supplying what the platform otherwise would.
- *
- * @a11y `role="menu"` on the panel, named by `label`, `labelledBy` or its trigger; `menuitem`,
- * `menuitemcheckbox` and `menuitemradio` on the items, with `aria-checked` on the last two, `role="group"`
- * around a titled section and `role="separator"` between them.
- * @a11y The trigger carries `aria-haspopup="menu"`, `aria-expanded` and `aria-controls`; a submenu's item
- * carries the same three, which is what says it opens another menu.
- * @a11y A disabled item is `aria-disabled` and stays focusable, as APG asks — the `disabled` attribute
- * would take it out of the keyboard's reach and silence it.
- * @keyboard Enter / Space — On the trigger, opens the menu with the first item focused. On an item,
- * chooses it. On a submenu's item, opens the submenu.
- * @keyboard Down / Up — On the trigger, opens the menu at its first or last item. Inside, moves between
- * items and wraps at the ends.
- * @keyboard Home / End — The first or the last item.
- * @keyboard Right / Left — Opens the submenu of the item that has focus, and closes the submenu focus is
- * in — the other way round in a right-to-left menu, which is APG's rule and the reading order's.
- * @keyboard Escape — Closes the innermost menu and puts focus back on what opened it.
- * @keyboard Tab — Closes the menu and moves focus on, as APG asks.
- * @keyboard A printable character — Typeahead: jumps to the item whose text starts with what was typed,
- * and the same letter again cycles through the items starting with it.
- * @pattern https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/
- */
-declare function MenuImpl<TKey extends keyof ComponentsAndVariants = 'menu'>(props: MenuProps<TKey>): import("react").JSX.Element;
-/**
- * A submenu: an item that opens a menu of its own. The panel is declared beside its item, *inside* the
- * menu it belongs to, which is what makes it a nested popover — so opening it leaves the parent menu open
- * and a press inside it is a press inside the parent (measured in Chrome 152).
- *
- * @a11y The item carries `role="menuitem"`, `aria-haspopup="menu"` and `aria-expanded`, and the submenu is
- * named after it.
- * @keyboard Right / Enter / Space — Opens it and focuses its first item. Left in a right-to-left menu,
- * which is the reading order rather than the key.
- * @keyboard Left / Escape — Closes it and puts focus back on the item that opened it.
- */
-declare function MenuSub<TKey extends keyof ComponentsAndVariants = 'menu'>(props: MenuSubProps<TKey>): import("react").JSX.Element;
 /** One command in the menu. A `<button>`, so Enter and Space are the browser's. */
 declare function MenuItem<TKey extends keyof ComponentsAndVariants = 'menu.item'>(props: MenuItemProps<TKey>): import("react").JSX.Element;
 /** An item that carries a state of its own: `role="menuitemcheckbox"` and a tick. */
@@ -224,13 +153,13 @@ declare function MenuRadioItem<TKey extends keyof ComponentsAndVariants = 'menu.
 declare function MenuGroup<TKey extends keyof ComponentsAndVariants = 'menu.group'>(props: MenuGroupProps<TKey>): import("react").JSX.Element;
 /** The line between two sections. `role="separator"`, which a menu is allowed to own. */
 declare function MenuSeparator<TKey extends keyof ComponentsAndVariants = 'menu.separator'>(props: MenuSeparatorProps<TKey>): import("react").JSX.Element;
-declare const Menu: typeof MenuImpl & {
+declare const Menu: (<TKey extends keyof ComponentsAndVariants = "menu">(props: MenuProps<TKey>) => React.ReactNode) & {
     Item: typeof MenuItem;
     CheckboxItem: typeof MenuCheckboxItem;
     RadioGroup: typeof MenuRadioGroup;
     RadioItem: typeof MenuRadioItem;
     Group: typeof MenuGroup;
     Separator: typeof MenuSeparator;
-    Sub: typeof MenuSub;
+    Sub: <TKey extends keyof ComponentsAndVariants = "menu">(props: MenuSubProps<TKey>) => React.ReactNode;
 };
 export default Menu;