Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,10 @@
"import": "./dist/primitives/select/index.js",
"types": "./dist/primitives/select/index.d.ts"
},
"./menu": {
"import": "./dist/primitives/menu/index.js",
"types": "./dist/primitives/menu/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
157 changes: 157 additions & 0 deletions packages/headless/src/primitives/menu/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
# Menu

A dropdown menu with keyboard navigation, typeahead, and nested submenu support. Handles ARIA roles, safe hover zones for submenus, and tree-level close-on-click.

## When to Use

- Action menus, context menus, dropdown menus attached to a button trigger.
- When you need nested submenus with safe pointer zones between trigger and submenu.
- Prefer Menu over Popover when the content is a list of actions/commands rather than arbitrary content.

## Usage

```tsx
import { Menu } from '@/primitives/menu';

<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item
label='Edit'
onClick={() => handleEdit()}
/>
<Menu.Item
label='Duplicate'
onClick={() => handleDuplicate()}
/>
<Menu.Separator />
<Menu.Item
label='Delete'
onClick={() => handleDelete()}
/>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>;
```

### Nested Submenus

Nest a `<Menu.Root>` inside a parent `<Menu.Root>` — the nested trigger automatically renders as a `menuitem` and opens on hover with a safe polygon zone.

```tsx
<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Edit' />
<Menu.Root>
<Menu.Trigger>Share</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Copy Link' />
<Menu.Item label='Email' />
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
```

### Controlled

```tsx
const [open, setOpen] = useState(false);

<Menu.Root
open={open}
onOpenChange={setOpen}
>
{/* ... */}
</Menu.Root>;
```

## Parts

| Part | Default Element | Description |
| ----------------- | --------------- | -------------------------------------- |
| `Menu.Root` | — | Root context provider |
| `Menu.Trigger` | `<button>` | Opens/closes the menu |
| `Menu.Portal` | — | Portals children (accepts `root` prop) |
| `Menu.Positioner` | `<div>` | Floating positioned container |
| `Menu.Popup` | `<div>` | Visual wrapper for menu items |
| `Menu.Item` | `<button>` | A menu action item |
| `Menu.Separator` | `<div>` | Visual divider between items |
| `Menu.Arrow` | `<svg>` | Optional floating arrow |

## Props

### `Menu.Root`

| Prop | Type | Default | Description |
| -------------- | ------------------------- | ------------------------------------------------- | ---------------------------------- |
| `open` | `boolean` | — | Controlled open state |
| `defaultOpen` | `boolean` | `false` | Initial open state (uncontrolled) |
| `onOpenChange` | `(open: boolean) => void` | — | Called when open state changes |
| `placement` | `Placement` | `"bottom-start"` (root), `"right-start"` (nested) | Floating UI placement |
| `sideOffset` | `number` | `4` (root), `0` (nested) | Gap between trigger and popup (px) |

### `Menu.Item`

| Prop | Type | Default | Description |
| -------------- | --------- | ------------ | ------------------------------------------------------ |
| `label` | `string` | **required** | Item text, also used for typeahead matching |
| `disabled` | `boolean` | — | Prevents click handler, keeps item focusable |
| `closeOnClick` | `boolean` | `true` | Whether clicking this item closes the entire menu tree |

### `Menu.Trigger`, `Menu.Positioner`, `Menu.Popup`, `Menu.Separator`

No additional props beyond standard HTML attributes and the `render` prop.

### `Menu.Arrow`

Accepts all `FloatingArrow` props. `ref` and `context` are injected automatically.

## Keyboard Navigation

| Key | Action |
| ----------------- | -------------------------------------- |
| `ArrowDown` | Move to next item |
| `ArrowUp` | Move to previous item |
| `ArrowRight` | Open nested submenu |
| `ArrowLeft` | Close nested submenu, return to parent |
| `Enter` / `Space` | Activate the focused item |
| `Escape` | Close the current menu level |
| Type a character | Jump to matching item (typeahead) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ------------------------------------ |
| `data-cl-slot` | All parts | Part identifier (e.g. `"menu-item"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Menu open state |
| `data-cl-active` | Item | Keyboard-focused item |
| `data-cl-disabled` | Item | Disabled item |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Nested Menu Behavior

- Nested menus open on hover (75ms delay) with a `safePolygon` safe zone.
- Only one sibling submenu can be open at a time.
- Clicking any item with `closeOnClick={true}` (default) closes the entire menu tree via a tree event.
- `Escape` closes the innermost menu first, bubbling up through the tree.

## Important Notes

- **No built-in animations.** The positioner simply mounts/unmounts. Use `data-cl-open`/`data-cl-closed` for CSS-driven transitions.
- **Disabled items use `aria-disabled`, not `disabled`.** They remain focusable for keyboard users.
- **`label` is required on `Menu.Item`** — it drives typeahead matching. Disabled items are excluded from typeahead.

## ARIA

- Popup: `role="menu"`
- Item: `role="menuitem"`, `aria-disabled`
- Separator: `role="separator"`
- Trigger: `aria-expanded`, `aria-haspopup="menu"`, `aria-controls`
- Nested trigger: `role="menuitem"` (instead of button)
12 changes: 12 additions & 0 deletions packages/headless/src/primitives/menu/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
export * as Menu from './parts';

export type {
MenuArrowProps,
MenuItemProps,
MenuPopupProps,
MenuPortalProps,
MenuPositionerProps,
MenuProps,
MenuSeparatorProps,
MenuTriggerProps,
} from './parts';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/menu/menu-arrow.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
'use client';

import { FloatingArrow } from '@floating-ui/react';
import React from 'react';
import { useMenuContext } from './menu-context';

export interface MenuArrowProps extends React.ComponentPropsWithRef<typeof FloatingArrow> {}

export function MenuArrow(props: MenuArrowProps) {
const { floatingContext, arrowRef, placement } = useMenuContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='menu-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
40 changes: 40 additions & 0 deletions packages/headless/src/primitives/menu/menu-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type {
ExtendedRefs,
FloatingContext,
Placement,
ReferenceType,
UseInteractionsReturn,
} from '@floating-ui/react';
import { type CSSProperties, createContext, useContext } from 'react';
import type { TransitionProps } from '../../hooks/use-transition';

export interface MenuContextValue {
open: boolean;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
getItemProps: UseInteractionsReturn['getItemProps'];
activeIndex: number | null;
setActiveIndex: React.Dispatch<React.SetStateAction<number | null>>;
elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
labelsRef: React.MutableRefObject<Array<string | null>>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
popupRef: React.RefObject<HTMLDivElement | null>;
isNested: boolean;
mounted: boolean;
transitionProps: TransitionProps;
parentContext: MenuContextValue | null;
}

export const MenuContext = createContext<MenuContextValue | null>(null);

export function useMenuContext() {
const ctx = useContext(MenuContext);
if (!ctx) {
throw new Error('Menu compound components must be used within <Menu>');
}
return ctx;
}
52 changes: 52 additions & 0 deletions packages/headless/src/primitives/menu/menu-item.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
'use client';

import { useFloatingTree, useListItem } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuItemProps extends ComponentProps<'button'> {
label: string;
disabled?: boolean;
closeOnClick?: boolean;
}

export function MenuItem(props: MenuItemProps) {
const { render, label, disabled, closeOnClick = true, ...otherProps } = props;
const { activeIndex, getItemProps } = useMenuContext();
const tree = useFloatingTree();
const item = useListItem({ label: disabled ? null : label });
const isActive = item.index === activeIndex;

const state = {
active: isActive,
disabled: !!disabled,
};

const defaultProps = {
'data-cl-slot': 'menu-item',
type: 'button' as const,
ref: item.ref,
role: 'menuitem' as const,
tabIndex: isActive ? 0 : -1,
...(disabled && { 'aria-disabled': true as const }),
...(getItemProps({
onClick() {
if (!disabled && closeOnClick) {
tree?.events.emit('click');
}
},
}) as React.ComponentPropsWithRef<'button'>),
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
active: (v: boolean) => (v ? { 'data-cl-active': '' } : null),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/menu/menu-popup.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuPopupProps extends ComponentProps<'div'> {}

export function MenuPopup(props: MenuPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = useMenuContext();

const defaultProps = {
'data-cl-slot': 'menu-popup',
ref: popupRef,
...transitionProps,
};

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/menu/menu-portal.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
'use client';

import { FloatingPortal } from '@floating-ui/react';
import type { ReactNode } from 'react';
import { useMenuContext } from './menu-context';

export interface MenuPortalProps {
children: ReactNode;
root?: HTMLElement | null | React.RefObject<HTMLElement | null>;
}

export function MenuPortal(props: MenuPortalProps) {
const { mounted } = useMenuContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,10 @@
"import": "./dist/primitives/select/index.js",
"types": "./dist/primitives/select/index.d.ts"
},
"./menu": {
"import": "./dist/primitives/menu/index.js",
"types": "./dist/primitives/menu/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
157 changes: 157 additions & 0 deletions packages/headless/src/primitives/menu/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
# Menu

A dropdown menu with keyboard navigation, typeahead, and nested submenu support. Handles ARIA roles, safe hover zones for submenus, and tree-level close-on-click.

## When to Use

- Action menus, context menus, dropdown menus attached to a button trigger.
- When you need nested submenus with safe pointer zones between trigger and submenu.
- Prefer Menu over Popover when the content is a list of actions/commands rather than arbitrary content.

## Usage

```tsx
import { Menu } from '@/primitives/menu';

<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item
label='Edit'
onClick={() => handleEdit()}
/>
<Menu.Item
label='Duplicate'
onClick={() => handleDuplicate()}
/>
<Menu.Separator />
<Menu.Item
label='Delete'
onClick={() => handleDelete()}
/>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>;
```

### Nested Submenus

Nest a `<Menu.Root>` inside a parent `<Menu.Root>` — the nested trigger automatically renders as a `menuitem` and opens on hover with a safe polygon zone.

```tsx
<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Edit' />
<Menu.Root>
<Menu.Trigger>Share</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Copy Link' />
<Menu.Item label='Email' />
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
```

### Controlled

```tsx
const [open, setOpen] = useState(false);

<Menu.Root
open={open}
onOpenChange={setOpen}
>
{/* ... */}
</Menu.Root>;
```

## Parts

| Part | Default Element | Description |
| ----------------- | --------------- | -------------------------------------- |
| `Menu.Root` | — | Root context provider |
| `Menu.Trigger` | `<button>` | Opens/closes the menu |
| `Menu.Portal` | — | Portals children (accepts `root` prop) |
| `Menu.Positioner` | `<div>` | Floating positioned container |
| `Menu.Popup` | `<div>` | Visual wrapper for menu items |
| `Menu.Item` | `<button>` | A menu action item |
| `Menu.Separator` | `<div>` | Visual divider between items |
| `Menu.Arrow` | `<svg>` | Optional floating arrow |

## Props

### `Menu.Root`

| Prop | Type | Default | Description |
| -------------- | ------------------------- | ------------------------------------------------- | ---------------------------------- |
| `open` | `boolean` | — | Controlled open state |
| `defaultOpen` | `boolean` | `false` | Initial open state (uncontrolled) |
| `onOpenChange` | `(open: boolean) => void` | — | Called when open state changes |
| `placement` | `Placement` | `"bottom-start"` (root), `"right-start"` (nested) | Floating UI placement |
| `sideOffset` | `number` | `4` (root), `0` (nested) | Gap between trigger and popup (px) |

### `Menu.Item`

| Prop | Type | Default | Description |
| -------------- | --------- | ------------ | ------------------------------------------------------ |
| `label` | `string` | **required** | Item text, also used for typeahead matching |
| `disabled` | `boolean` | — | Prevents click handler, keeps item focusable |
| `closeOnClick` | `boolean` | `true` | Whether clicking this item closes the entire menu tree |

### `Menu.Trigger`, `Menu.Positioner`, `Menu.Popup`, `Menu.Separator`

No additional props beyond standard HTML attributes and the `render` prop.

### `Menu.Arrow`

Accepts all `FloatingArrow` props. `ref` and `context` are injected automatically.

## Keyboard Navigation

| Key | Action |
| ----------------- | -------------------------------------- |
| `ArrowDown` | Move to next item |
| `ArrowUp` | Move to previous item |
| `ArrowRight` | Open nested submenu |
| `ArrowLeft` | Close nested submenu, return to parent |
| `Enter` / `Space` | Activate the focused item |
| `Escape` | Close the current menu level |
| Type a character | Jump to matching item (typeahead) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ------------------------------------ |
| `data-cl-slot` | All parts | Part identifier (e.g. `"menu-item"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Menu open state |
| `data-cl-active` | Item | Keyboard-focused item |
| `data-cl-disabled` | Item | Disabled item |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Nested Menu Behavior

- Nested menus open on hover (75ms delay) with a `safePolygon` safe zone.
- Only one sibling submenu can be open at a time.
- Clicking any item with `closeOnClick={true}` (default) closes the entire menu tree via a tree event.
- `Escape` closes the innermost menu first, bubbling up through the tree.

## Important Notes

- **No built-in animations.** The positioner simply mounts/unmounts. Use `data-cl-open`/`data-cl-closed` for CSS-driven transitions.
- **Disabled items use `aria-disabled`, not `disabled`.** They remain focusable for keyboard users.
- **`label` is required on `Menu.Item`** — it drives typeahead matching. Disabled items are excluded from typeahead.

## ARIA

- Popup: `role="menu"`
- Item: `role="menuitem"`, `aria-disabled`
- Separator: `role="separator"`
- Trigger: `aria-expanded`, `aria-haspopup="menu"`, `aria-controls`
- Nested trigger: `role="menuitem"` (instead of button)
12 changes: 12 additions & 0 deletions packages/headless/src/primitives/menu/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
export * as Menu from './parts';

export type {
MenuArrowProps,
MenuItemProps,
MenuPopupProps,
MenuPortalProps,
MenuPositionerProps,
MenuProps,
MenuSeparatorProps,
MenuTriggerProps,
} from './parts';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/menu/menu-arrow.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
'use client';

import { FloatingArrow } from '@floating-ui/react';
import React from 'react';
import { useMenuContext } from './menu-context';

export interface MenuArrowProps extends React.ComponentPropsWithRef<typeof FloatingArrow> {}

export function MenuArrow(props: MenuArrowProps) {
const { floatingContext, arrowRef, placement } = useMenuContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='menu-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
40 changes: 40 additions & 0 deletions packages/headless/src/primitives/menu/menu-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type {
ExtendedRefs,
FloatingContext,
Placement,
ReferenceType,
UseInteractionsReturn,
} from '@floating-ui/react';
import { type CSSProperties, createContext, useContext } from 'react';
import type { TransitionProps } from '../../hooks/use-transition';

export interface MenuContextValue {
open: boolean;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
getItemProps: UseInteractionsReturn['getItemProps'];
activeIndex: number | null;
setActiveIndex: React.Dispatch<React.SetStateAction<number | null>>;
elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
labelsRef: React.MutableRefObject<Array<string | null>>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
popupRef: React.RefObject<HTMLDivElement | null>;
isNested: boolean;
mounted: boolean;
transitionProps: TransitionProps;
parentContext: MenuContextValue | null;
}

export const MenuContext = createContext<MenuContextValue | null>(null);

export function useMenuContext() {
const ctx = useContext(MenuContext);
if (!ctx) {
throw new Error('Menu compound components must be used within <Menu>');
}
return ctx;
}
52 changes: 52 additions & 0 deletions packages/headless/src/primitives/menu/menu-item.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
'use client';

import { useFloatingTree, useListItem } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuItemProps extends ComponentProps<'button'> {
label: string;
disabled?: boolean;
closeOnClick?: boolean;
}

export function MenuItem(props: MenuItemProps) {
const { render, label, disabled, closeOnClick = true, ...otherProps } = props;
const { activeIndex, getItemProps } = useMenuContext();
const tree = useFloatingTree();
const item = useListItem({ label: disabled ? null : label });
const isActive = item.index === activeIndex;

const state = {
active: isActive,
disabled: !!disabled,
};

const defaultProps = {
'data-cl-slot': 'menu-item',
type: 'button' as const,
ref: item.ref,
role: 'menuitem' as const,
tabIndex: isActive ? 0 : -1,
...(disabled && { 'aria-disabled': true as const }),
...(getItemProps({
onClick() {
if (!disabled && closeOnClick) {
tree?.events.emit('click');
}
},
}) as React.ComponentPropsWithRef<'button'>),
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
active: (v: boolean) => (v ? { 'data-cl-active': '' } : null),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/menu/menu-popup.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuPopupProps extends ComponentProps<'div'> {}

export function MenuPopup(props: MenuPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = useMenuContext();

const defaultProps = {
'data-cl-slot': 'menu-popup',
ref: popupRef,
...transitionProps,
};

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/menu/menu-portal.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
'use client';

import { FloatingPortal } from '@floating-ui/react';
import type { ReactNode } from 'react';
import { useMenuContext } from './menu-context';

export interface MenuPortalProps {
children: ReactNode;
root?: HTMLElement | null | React.RefObject<HTMLElement | null>;
}

export function MenuPortal(props: MenuPortalProps) {
const { mounted } = useMenuContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,10 @@
"import": "./dist/primitives/select/index.js",
"types": "./dist/primitives/select/index.d.ts"
},
"./menu": {
"import": "./dist/primitives/menu/index.js",
"types": "./dist/primitives/menu/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
157 changes: 157 additions & 0 deletions packages/headless/src/primitives/menu/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
# Menu

A dropdown menu with keyboard navigation, typeahead, and nested submenu support. Handles ARIA roles, safe hover zones for submenus, and tree-level close-on-click.

## When to Use

- Action menus, context menus, dropdown menus attached to a button trigger.
- When you need nested submenus with safe pointer zones between trigger and submenu.
- Prefer Menu over Popover when the content is a list of actions/commands rather than arbitrary content.

## Usage

```tsx
import { Menu } from '@/primitives/menu';

<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item
label='Edit'
onClick={() => handleEdit()}
/>
<Menu.Item
label='Duplicate'
onClick={() => handleDuplicate()}
/>
<Menu.Separator />
<Menu.Item
label='Delete'
onClick={() => handleDelete()}
/>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>;
```

### Nested Submenus

Nest a `<Menu.Root>` inside a parent `<Menu.Root>` — the nested trigger automatically renders as a `menuitem` and opens on hover with a safe polygon zone.

```tsx
<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Edit' />
<Menu.Root>
<Menu.Trigger>Share</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Copy Link' />
<Menu.Item label='Email' />
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
```

### Controlled

```tsx
const [open, setOpen] = useState(false);

<Menu.Root
open={open}
onOpenChange={setOpen}
>
{/* ... */}
</Menu.Root>;
```

## Parts

| Part | Default Element | Description |
| ----------------- | --------------- | -------------------------------------- |
| `Menu.Root` | — | Root context provider |
| `Menu.Trigger` | `<button>` | Opens/closes the menu |
| `Menu.Portal` | — | Portals children (accepts `root` prop) |
| `Menu.Positioner` | `<div>` | Floating positioned container |
| `Menu.Popup` | `<div>` | Visual wrapper for menu items |
| `Menu.Item` | `<button>` | A menu action item |
| `Menu.Separator` | `<div>` | Visual divider between items |
| `Menu.Arrow` | `<svg>` | Optional floating arrow |

## Props

### `Menu.Root`

| Prop | Type | Default | Description |
| -------------- | ------------------------- | ------------------------------------------------- | ---------------------------------- |
| `open` | `boolean` | — | Controlled open state |
| `defaultOpen` | `boolean` | `false` | Initial open state (uncontrolled) |
| `onOpenChange` | `(open: boolean) => void` | — | Called when open state changes |
| `placement` | `Placement` | `"bottom-start"` (root), `"right-start"` (nested) | Floating UI placement |
| `sideOffset` | `number` | `4` (root), `0` (nested) | Gap between trigger and popup (px) |

### `Menu.Item`

| Prop | Type | Default | Description |
| -------------- | --------- | ------------ | ------------------------------------------------------ |
| `label` | `string` | **required** | Item text, also used for typeahead matching |
| `disabled` | `boolean` | — | Prevents click handler, keeps item focusable |
| `closeOnClick` | `boolean` | `true` | Whether clicking this item closes the entire menu tree |

### `Menu.Trigger`, `Menu.Positioner`, `Menu.Popup`, `Menu.Separator`

No additional props beyond standard HTML attributes and the `render` prop.

### `Menu.Arrow`

Accepts all `FloatingArrow` props. `ref` and `context` are injected automatically.

## Keyboard Navigation

| Key | Action |
| ----------------- | -------------------------------------- |
| `ArrowDown` | Move to next item |
| `ArrowUp` | Move to previous item |
| `ArrowRight` | Open nested submenu |
| `ArrowLeft` | Close nested submenu, return to parent |
| `Enter` / `Space` | Activate the focused item |
| `Escape` | Close the current menu level |
| Type a character | Jump to matching item (typeahead) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ------------------------------------ |
| `data-cl-slot` | All parts | Part identifier (e.g. `"menu-item"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Menu open state |
| `data-cl-active` | Item | Keyboard-focused item |
| `data-cl-disabled` | Item | Disabled item |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Nested Menu Behavior

- Nested menus open on hover (75ms delay) with a `safePolygon` safe zone.
- Only one sibling submenu can be open at a time.
- Clicking any item with `closeOnClick={true}` (default) closes the entire menu tree via a tree event.
- `Escape` closes the innermost menu first, bubbling up through the tree.

## Important Notes

- **No built-in animations.** The positioner simply mounts/unmounts. Use `data-cl-open`/`data-cl-closed` for CSS-driven transitions.
- **Disabled items use `aria-disabled`, not `disabled`.** They remain focusable for keyboard users.
- **`label` is required on `Menu.Item`** — it drives typeahead matching. Disabled items are excluded from typeahead.

## ARIA

- Popup: `role="menu"`
- Item: `role="menuitem"`, `aria-disabled`
- Separator: `role="separator"`
- Trigger: `aria-expanded`, `aria-haspopup="menu"`, `aria-controls`
- Nested trigger: `role="menuitem"` (instead of button)
12 changes: 12 additions & 0 deletions packages/headless/src/primitives/menu/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
export * as Menu from './parts';

export type {
MenuArrowProps,
MenuItemProps,
MenuPopupProps,
MenuPortalProps,
MenuPositionerProps,
MenuProps,
MenuSeparatorProps,
MenuTriggerProps,
} from './parts';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/menu/menu-arrow.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
'use client';

import { FloatingArrow } from '@floating-ui/react';
import React from 'react';
import { useMenuContext } from './menu-context';

export interface MenuArrowProps extends React.ComponentPropsWithRef<typeof FloatingArrow> {}

export function MenuArrow(props: MenuArrowProps) {
const { floatingContext, arrowRef, placement } = useMenuContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='menu-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
40 changes: 40 additions & 0 deletions packages/headless/src/primitives/menu/menu-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type {
ExtendedRefs,
FloatingContext,
Placement,
ReferenceType,
UseInteractionsReturn,
} from '@floating-ui/react';
import { type CSSProperties, createContext, useContext } from 'react';
import type { TransitionProps } from '../../hooks/use-transition';

export interface MenuContextValue {
open: boolean;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
getItemProps: UseInteractionsReturn['getItemProps'];
activeIndex: number | null;
setActiveIndex: React.Dispatch<React.SetStateAction<number | null>>;
elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
labelsRef: React.MutableRefObject<Array<string | null>>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
popupRef: React.RefObject<HTMLDivElement | null>;
isNested: boolean;
mounted: boolean;
transitionProps: TransitionProps;
parentContext: MenuContextValue | null;
}

export const MenuContext = createContext<MenuContextValue | null>(null);

export function useMenuContext() {
const ctx = useContext(MenuContext);
if (!ctx) {
throw new Error('Menu compound components must be used within <Menu>');
}
return ctx;
}
52 changes: 52 additions & 0 deletions packages/headless/src/primitives/menu/menu-item.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
'use client';

import { useFloatingTree, useListItem } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuItemProps extends ComponentProps<'button'> {
label: string;
disabled?: boolean;
closeOnClick?: boolean;
}

export function MenuItem(props: MenuItemProps) {
const { render, label, disabled, closeOnClick = true, ...otherProps } = props;
const { activeIndex, getItemProps } = useMenuContext();
const tree = useFloatingTree();
const item = useListItem({ label: disabled ? null : label });
const isActive = item.index === activeIndex;

const state = {
active: isActive,
disabled: !!disabled,
};

const defaultProps = {
'data-cl-slot': 'menu-item',
type: 'button' as const,
ref: item.ref,
role: 'menuitem' as const,
tabIndex: isActive ? 0 : -1,
...(disabled && { 'aria-disabled': true as const }),
...(getItemProps({
onClick() {
if (!disabled && closeOnClick) {
tree?.events.emit('click');
}
},
}) as React.ComponentPropsWithRef<'button'>),
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
active: (v: boolean) => (v ? { 'data-cl-active': '' } : null),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/menu/menu-popup.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuPopupProps extends ComponentProps<'div'> {}

export function MenuPopup(props: MenuPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = useMenuContext();

const defaultProps = {
'data-cl-slot': 'menu-popup',
ref: popupRef,
...transitionProps,
};

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/menu/menu-portal.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
'use client';

import { FloatingPortal } from '@floating-ui/react';
import type { ReactNode } from 'react';
import { useMenuContext } from './menu-context';

export interface MenuPortalProps {
children: ReactNode;
root?: HTMLElement | null | React.RefObject<HTMLElement | null>;
}

export function MenuPortal(props: MenuPortalProps) {
const { mounted } = useMenuContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,10 @@
"import": "./dist/primitives/select/index.js",
"types": "./dist/primitives/select/index.d.ts"
},
"./menu": {
"import": "./dist/primitives/menu/index.js",
"types": "./dist/primitives/menu/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
157 changes: 157 additions & 0 deletions packages/headless/src/primitives/menu/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
# Menu

A dropdown menu with keyboard navigation, typeahead, and nested submenu support. Handles ARIA roles, safe hover zones for submenus, and tree-level close-on-click.

## When to Use

- Action menus, context menus, dropdown menus attached to a button trigger.
- When you need nested submenus with safe pointer zones between trigger and submenu.
- Prefer Menu over Popover when the content is a list of actions/commands rather than arbitrary content.

## Usage

```tsx
import { Menu } from '@/primitives/menu';

<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item
label='Edit'
onClick={() => handleEdit()}
/>
<Menu.Item
label='Duplicate'
onClick={() => handleDuplicate()}
/>
<Menu.Separator />
<Menu.Item
label='Delete'
onClick={() => handleDelete()}
/>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>;
```

### Nested Submenus

Nest a `<Menu.Root>` inside a parent `<Menu.Root>` — the nested trigger automatically renders as a `menuitem` and opens on hover with a safe polygon zone.

```tsx
<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Edit' />
<Menu.Root>
<Menu.Trigger>Share</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Copy Link' />
<Menu.Item label='Email' />
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
```

### Controlled

```tsx
const [open, setOpen] = useState(false);

<Menu.Root
open={open}
onOpenChange={setOpen}
>
{/* ... */}
</Menu.Root>;
```

## Parts

| Part | Default Element | Description |
| ----------------- | --------------- | -------------------------------------- |
| `Menu.Root` | — | Root context provider |
| `Menu.Trigger` | `<button>` | Opens/closes the menu |
| `Menu.Portal` | — | Portals children (accepts `root` prop) |
| `Menu.Positioner` | `<div>` | Floating positioned container |
| `Menu.Popup` | `<div>` | Visual wrapper for menu items |
| `Menu.Item` | `<button>` | A menu action item |
| `Menu.Separator` | `<div>` | Visual divider between items |
| `Menu.Arrow` | `<svg>` | Optional floating arrow |

## Props

### `Menu.Root`

| Prop | Type | Default | Description |
| -------------- | ------------------------- | ------------------------------------------------- | ---------------------------------- |
| `open` | `boolean` | — | Controlled open state |
| `defaultOpen` | `boolean` | `false` | Initial open state (uncontrolled) |
| `onOpenChange` | `(open: boolean) => void` | — | Called when open state changes |
| `placement` | `Placement` | `"bottom-start"` (root), `"right-start"` (nested) | Floating UI placement |
| `sideOffset` | `number` | `4` (root), `0` (nested) | Gap between trigger and popup (px) |

### `Menu.Item`

| Prop | Type | Default | Description |
| -------------- | --------- | ------------ | ------------------------------------------------------ |
| `label` | `string` | **required** | Item text, also used for typeahead matching |
| `disabled` | `boolean` | — | Prevents click handler, keeps item focusable |
| `closeOnClick` | `boolean` | `true` | Whether clicking this item closes the entire menu tree |

### `Menu.Trigger`, `Menu.Positioner`, `Menu.Popup`, `Menu.Separator`

No additional props beyond standard HTML attributes and the `render` prop.

### `Menu.Arrow`

Accepts all `FloatingArrow` props. `ref` and `context` are injected automatically.

## Keyboard Navigation

| Key | Action |
| ----------------- | -------------------------------------- |
| `ArrowDown` | Move to next item |
| `ArrowUp` | Move to previous item |
| `ArrowRight` | Open nested submenu |
| `ArrowLeft` | Close nested submenu, return to parent |
| `Enter` / `Space` | Activate the focused item |
| `Escape` | Close the current menu level |
| Type a character | Jump to matching item (typeahead) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ------------------------------------ |
| `data-cl-slot` | All parts | Part identifier (e.g. `"menu-item"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Menu open state |
| `data-cl-active` | Item | Keyboard-focused item |
| `data-cl-disabled` | Item | Disabled item |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Nested Menu Behavior

- Nested menus open on hover (75ms delay) with a `safePolygon` safe zone.
- Only one sibling submenu can be open at a time.
- Clicking any item with `closeOnClick={true}` (default) closes the entire menu tree via a tree event.
- `Escape` closes the innermost menu first, bubbling up through the tree.

## Important Notes

- **No built-in animations.** The positioner simply mounts/unmounts. Use `data-cl-open`/`data-cl-closed` for CSS-driven transitions.
- **Disabled items use `aria-disabled`, not `disabled`.** They remain focusable for keyboard users.
- **`label` is required on `Menu.Item`** — it drives typeahead matching. Disabled items are excluded from typeahead.

## ARIA

- Popup: `role="menu"`
- Item: `role="menuitem"`, `aria-disabled`
- Separator: `role="separator"`
- Trigger: `aria-expanded`, `aria-haspopup="menu"`, `aria-controls`
- Nested trigger: `role="menuitem"` (instead of button)
12 changes: 12 additions & 0 deletions packages/headless/src/primitives/menu/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
export * as Menu from './parts';

export type {
MenuArrowProps,
MenuItemProps,
MenuPopupProps,
MenuPortalProps,
MenuPositionerProps,
MenuProps,
MenuSeparatorProps,
MenuTriggerProps,
} from './parts';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/menu/menu-arrow.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
'use client';

import { FloatingArrow } from '@floating-ui/react';
import React from 'react';
import { useMenuContext } from './menu-context';

export interface MenuArrowProps extends React.ComponentPropsWithRef<typeof FloatingArrow> {}

export function MenuArrow(props: MenuArrowProps) {
const { floatingContext, arrowRef, placement } = useMenuContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='menu-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
40 changes: 40 additions & 0 deletions packages/headless/src/primitives/menu/menu-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type {
ExtendedRefs,
FloatingContext,
Placement,
ReferenceType,
UseInteractionsReturn,
} from '@floating-ui/react';
import { type CSSProperties, createContext, useContext } from 'react';
import type { TransitionProps } from '../../hooks/use-transition';

export interface MenuContextValue {
open: boolean;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
getItemProps: UseInteractionsReturn['getItemProps'];
activeIndex: number | null;
setActiveIndex: React.Dispatch<React.SetStateAction<number | null>>;
elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
labelsRef: React.MutableRefObject<Array<string | null>>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
popupRef: React.RefObject<HTMLDivElement | null>;
isNested: boolean;
mounted: boolean;
transitionProps: TransitionProps;
parentContext: MenuContextValue | null;
}

export const MenuContext = createContext<MenuContextValue | null>(null);

export function useMenuContext() {
const ctx = useContext(MenuContext);
if (!ctx) {
throw new Error('Menu compound components must be used within <Menu>');
}
return ctx;
}
52 changes: 52 additions & 0 deletions packages/headless/src/primitives/menu/menu-item.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
'use client';

import { useFloatingTree, useListItem } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuItemProps extends ComponentProps<'button'> {
label: string;
disabled?: boolean;
closeOnClick?: boolean;
}

export function MenuItem(props: MenuItemProps) {
const { render, label, disabled, closeOnClick = true, ...otherProps } = props;
const { activeIndex, getItemProps } = useMenuContext();
const tree = useFloatingTree();
const item = useListItem({ label: disabled ? null : label });
const isActive = item.index === activeIndex;

const state = {
active: isActive,
disabled: !!disabled,
};

const defaultProps = {
'data-cl-slot': 'menu-item',
type: 'button' as const,
ref: item.ref,
role: 'menuitem' as const,
tabIndex: isActive ? 0 : -1,
...(disabled && { 'aria-disabled': true as const }),
...(getItemProps({
onClick() {
if (!disabled && closeOnClick) {
tree?.events.emit('click');
}
},
}) as React.ComponentPropsWithRef<'button'>),
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
active: (v: boolean) => (v ? { 'data-cl-active': '' } : null),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/menu/menu-popup.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuPopupProps extends ComponentProps<'div'> {}

export function MenuPopup(props: MenuPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = useMenuContext();

const defaultProps = {
'data-cl-slot': 'menu-popup',
ref: popupRef,
...transitionProps,
};

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/menu/menu-portal.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
'use client';

import { FloatingPortal } from '@floating-ui/react';
import type { ReactNode } from 'react';
import { useMenuContext } from './menu-context';

export interface MenuPortalProps {
children: ReactNode;
root?: HTMLElement | null | React.RefObject<HTMLElement | null>;
}

export function MenuPortal(props: MenuPortalProps) {
const { mounted } = useMenuContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,10 @@
"import": "./dist/primitives/select/index.js",
"types": "./dist/primitives/select/index.d.ts"
},
"./menu": {
"import": "./dist/primitives/menu/index.js",
"types": "./dist/primitives/menu/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
157 changes: 157 additions & 0 deletions packages/headless/src/primitives/menu/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
# Menu

A dropdown menu with keyboard navigation, typeahead, and nested submenu support. Handles ARIA roles, safe hover zones for submenus, and tree-level close-on-click.

## When to Use

- Action menus, context menus, dropdown menus attached to a button trigger.
- When you need nested submenus with safe pointer zones between trigger and submenu.
- Prefer Menu over Popover when the content is a list of actions/commands rather than arbitrary content.

## Usage

```tsx
import { Menu } from '@/primitives/menu';

<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item
label='Edit'
onClick={() => handleEdit()}
/>
<Menu.Item
label='Duplicate'
onClick={() => handleDuplicate()}
/>
<Menu.Separator />
<Menu.Item
label='Delete'
onClick={() => handleDelete()}
/>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>;
```

### Nested Submenus

Nest a `<Menu.Root>` inside a parent `<Menu.Root>` — the nested trigger automatically renders as a `menuitem` and opens on hover with a safe polygon zone.

```tsx
<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Edit' />
<Menu.Root>
<Menu.Trigger>Share</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Copy Link' />
<Menu.Item label='Email' />
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
```

### Controlled

```tsx
const [open, setOpen] = useState(false);

<Menu.Root
open={open}
onOpenChange={setOpen}
>
{/* ... */}
</Menu.Root>;
```

## Parts

| Part | Default Element | Description |
| ----------------- | --------------- | -------------------------------------- |
| `Menu.Root` | — | Root context provider |
| `Menu.Trigger` | `<button>` | Opens/closes the menu |
| `Menu.Portal` | — | Portals children (accepts `root` prop) |
| `Menu.Positioner` | `<div>` | Floating positioned container |
| `Menu.Popup` | `<div>` | Visual wrapper for menu items |
| `Menu.Item` | `<button>` | A menu action item |
| `Menu.Separator` | `<div>` | Visual divider between items |
| `Menu.Arrow` | `<svg>` | Optional floating arrow |

## Props

### `Menu.Root`

| Prop | Type | Default | Description |
| -------------- | ------------------------- | ------------------------------------------------- | ---------------------------------- |
| `open` | `boolean` | — | Controlled open state |
| `defaultOpen` | `boolean` | `false` | Initial open state (uncontrolled) |
| `onOpenChange` | `(open: boolean) => void` | — | Called when open state changes |
| `placement` | `Placement` | `"bottom-start"` (root), `"right-start"` (nested) | Floating UI placement |
| `sideOffset` | `number` | `4` (root), `0` (nested) | Gap between trigger and popup (px) |

### `Menu.Item`

| Prop | Type | Default | Description |
| -------------- | --------- | ------------ | ------------------------------------------------------ |
| `label` | `string` | **required** | Item text, also used for typeahead matching |
| `disabled` | `boolean` | — | Prevents click handler, keeps item focusable |
| `closeOnClick` | `boolean` | `true` | Whether clicking this item closes the entire menu tree |

### `Menu.Trigger`, `Menu.Positioner`, `Menu.Popup`, `Menu.Separator`

No additional props beyond standard HTML attributes and the `render` prop.

### `Menu.Arrow`

Accepts all `FloatingArrow` props. `ref` and `context` are injected automatically.

## Keyboard Navigation

| Key | Action |
| ----------------- | -------------------------------------- |
| `ArrowDown` | Move to next item |
| `ArrowUp` | Move to previous item |
| `ArrowRight` | Open nested submenu |
| `ArrowLeft` | Close nested submenu, return to parent |
| `Enter` / `Space` | Activate the focused item |
| `Escape` | Close the current menu level |
| Type a character | Jump to matching item (typeahead) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ------------------------------------ |
| `data-cl-slot` | All parts | Part identifier (e.g. `"menu-item"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Menu open state |
| `data-cl-active` | Item | Keyboard-focused item |
| `data-cl-disabled` | Item | Disabled item |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Nested Menu Behavior

- Nested menus open on hover (75ms delay) with a `safePolygon` safe zone.
- Only one sibling submenu can be open at a time.
- Clicking any item with `closeOnClick={true}` (default) closes the entire menu tree via a tree event.
- `Escape` closes the innermost menu first, bubbling up through the tree.

## Important Notes

- **No built-in animations.** The positioner simply mounts/unmounts. Use `data-cl-open`/`data-cl-closed` for CSS-driven transitions.
- **Disabled items use `aria-disabled`, not `disabled`.** They remain focusable for keyboard users.
- **`label` is required on `Menu.Item`** — it drives typeahead matching. Disabled items are excluded from typeahead.

## ARIA

- Popup: `role="menu"`
- Item: `role="menuitem"`, `aria-disabled`
- Separator: `role="separator"`
- Trigger: `aria-expanded`, `aria-haspopup="menu"`, `aria-controls`
- Nested trigger: `role="menuitem"` (instead of button)
12 changes: 12 additions & 0 deletions packages/headless/src/primitives/menu/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
export * as Menu from './parts';

export type {
MenuArrowProps,
MenuItemProps,
MenuPopupProps,
MenuPortalProps,
MenuPositionerProps,
MenuProps,
MenuSeparatorProps,
MenuTriggerProps,
} from './parts';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/menu/menu-arrow.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
'use client';

import { FloatingArrow } from '@floating-ui/react';
import React from 'react';
import { useMenuContext } from './menu-context';

export interface MenuArrowProps extends React.ComponentPropsWithRef<typeof FloatingArrow> {}

export function MenuArrow(props: MenuArrowProps) {
const { floatingContext, arrowRef, placement } = useMenuContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='menu-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
40 changes: 40 additions & 0 deletions packages/headless/src/primitives/menu/menu-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type {
ExtendedRefs,
FloatingContext,
Placement,
ReferenceType,
UseInteractionsReturn,
} from '@floating-ui/react';
import { type CSSProperties, createContext, useContext } from 'react';
import type { TransitionProps } from '../../hooks/use-transition';

export interface MenuContextValue {
open: boolean;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
getItemProps: UseInteractionsReturn['getItemProps'];
activeIndex: number | null;
setActiveIndex: React.Dispatch<React.SetStateAction<number | null>>;
elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
labelsRef: React.MutableRefObject<Array<string | null>>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
popupRef: React.RefObject<HTMLDivElement | null>;
isNested: boolean;
mounted: boolean;
transitionProps: TransitionProps;
parentContext: MenuContextValue | null;
}

export const MenuContext = createContext<MenuContextValue | null>(null);

export function useMenuContext() {
const ctx = useContext(MenuContext);
if (!ctx) {
throw new Error('Menu compound components must be used within <Menu>');
}
return ctx;
}
52 changes: 52 additions & 0 deletions packages/headless/src/primitives/menu/menu-item.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
'use client';

import { useFloatingTree, useListItem } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuItemProps extends ComponentProps<'button'> {
label: string;
disabled?: boolean;
closeOnClick?: boolean;
}

export function MenuItem(props: MenuItemProps) {
const { render, label, disabled, closeOnClick = true, ...otherProps } = props;
const { activeIndex, getItemProps } = useMenuContext();
const tree = useFloatingTree();
const item = useListItem({ label: disabled ? null : label });
const isActive = item.index === activeIndex;

const state = {
active: isActive,
disabled: !!disabled,
};

const defaultProps = {
'data-cl-slot': 'menu-item',
type: 'button' as const,
ref: item.ref,
role: 'menuitem' as const,
tabIndex: isActive ? 0 : -1,
...(disabled && { 'aria-disabled': true as const }),
...(getItemProps({
onClick() {
if (!disabled && closeOnClick) {
tree?.events.emit('click');
}
},
}) as React.ComponentPropsWithRef<'button'>),
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
active: (v: boolean) => (v ? { 'data-cl-active': '' } : null),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/menu/menu-popup.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuPopupProps extends ComponentProps<'div'> {}

export function MenuPopup(props: MenuPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = useMenuContext();

const defaultProps = {
'data-cl-slot': 'menu-popup',
ref: popupRef,
...transitionProps,
};

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/menu/menu-portal.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
'use client';

import { FloatingPortal } from '@floating-ui/react';
import type { ReactNode } from 'react';
import { useMenuContext } from './menu-context';

export interface MenuPortalProps {
children: ReactNode;
root?: HTMLElement | null | React.RefObject<HTMLElement | null>;
}

export function MenuPortal(props: MenuPortalProps) {
const { mounted } = useMenuContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,10 @@
"import": "./dist/primitives/select/index.js",
"types": "./dist/primitives/select/index.d.ts"
},
"./menu": {
"import": "./dist/primitives/menu/index.js",
"types": "./dist/primitives/menu/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
157 changes: 157 additions & 0 deletions packages/headless/src/primitives/menu/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
# Menu

A dropdown menu with keyboard navigation, typeahead, and nested submenu support. Handles ARIA roles, safe hover zones for submenus, and tree-level close-on-click.

## When to Use

- Action menus, context menus, dropdown menus attached to a button trigger.
- When you need nested submenus with safe pointer zones between trigger and submenu.
- Prefer Menu over Popover when the content is a list of actions/commands rather than arbitrary content.

## Usage

```tsx
import { Menu } from '@/primitives/menu';

<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item
label='Edit'
onClick={() => handleEdit()}
/>
<Menu.Item
label='Duplicate'
onClick={() => handleDuplicate()}
/>
<Menu.Separator />
<Menu.Item
label='Delete'
onClick={() => handleDelete()}
/>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>;
```

### Nested Submenus

Nest a `<Menu.Root>` inside a parent `<Menu.Root>` — the nested trigger automatically renders as a `menuitem` and opens on hover with a safe polygon zone.

```tsx
<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Edit' />
<Menu.Root>
<Menu.Trigger>Share</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Copy Link' />
<Menu.Item label='Email' />
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
```

### Controlled

```tsx
const [open, setOpen] = useState(false);

<Menu.Root
open={open}
onOpenChange={setOpen}
>
{/* ... */}
</Menu.Root>;
```

## Parts

| Part | Default Element | Description |
| ----------------- | --------------- | -------------------------------------- |
| `Menu.Root` | — | Root context provider |
| `Menu.Trigger` | `<button>` | Opens/closes the menu |
| `Menu.Portal` | — | Portals children (accepts `root` prop) |
| `Menu.Positioner` | `<div>` | Floating positioned container |
| `Menu.Popup` | `<div>` | Visual wrapper for menu items |
| `Menu.Item` | `<button>` | A menu action item |
| `Menu.Separator` | `<div>` | Visual divider between items |
| `Menu.Arrow` | `<svg>` | Optional floating arrow |

## Props

### `Menu.Root`

| Prop | Type | Default | Description |
| -------------- | ------------------------- | ------------------------------------------------- | ---------------------------------- |
| `open` | `boolean` | — | Controlled open state |
| `defaultOpen` | `boolean` | `false` | Initial open state (uncontrolled) |
| `onOpenChange` | `(open: boolean) => void` | — | Called when open state changes |
| `placement` | `Placement` | `"bottom-start"` (root), `"right-start"` (nested) | Floating UI placement |
| `sideOffset` | `number` | `4` (root), `0` (nested) | Gap between trigger and popup (px) |

### `Menu.Item`

| Prop | Type | Default | Description |
| -------------- | --------- | ------------ | ------------------------------------------------------ |
| `label` | `string` | **required** | Item text, also used for typeahead matching |
| `disabled` | `boolean` | — | Prevents click handler, keeps item focusable |
| `closeOnClick` | `boolean` | `true` | Whether clicking this item closes the entire menu tree |

### `Menu.Trigger`, `Menu.Positioner`, `Menu.Popup`, `Menu.Separator`

No additional props beyond standard HTML attributes and the `render` prop.

### `Menu.Arrow`

Accepts all `FloatingArrow` props. `ref` and `context` are injected automatically.

## Keyboard Navigation

| Key | Action |
| ----------------- | -------------------------------------- |
| `ArrowDown` | Move to next item |
| `ArrowUp` | Move to previous item |
| `ArrowRight` | Open nested submenu |
| `ArrowLeft` | Close nested submenu, return to parent |
| `Enter` / `Space` | Activate the focused item |
| `Escape` | Close the current menu level |
| Type a character | Jump to matching item (typeahead) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ------------------------------------ |
| `data-cl-slot` | All parts | Part identifier (e.g. `"menu-item"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Menu open state |
| `data-cl-active` | Item | Keyboard-focused item |
| `data-cl-disabled` | Item | Disabled item |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Nested Menu Behavior

- Nested menus open on hover (75ms delay) with a `safePolygon` safe zone.
- Only one sibling submenu can be open at a time.
- Clicking any item with `closeOnClick={true}` (default) closes the entire menu tree via a tree event.
- `Escape` closes the innermost menu first, bubbling up through the tree.

## Important Notes

- **No built-in animations.** The positioner simply mounts/unmounts. Use `data-cl-open`/`data-cl-closed` for CSS-driven transitions.
- **Disabled items use `aria-disabled`, not `disabled`.** They remain focusable for keyboard users.
- **`label` is required on `Menu.Item`** — it drives typeahead matching. Disabled items are excluded from typeahead.

## ARIA

- Popup: `role="menu"`
- Item: `role="menuitem"`, `aria-disabled`
- Separator: `role="separator"`
- Trigger: `aria-expanded`, `aria-haspopup="menu"`, `aria-controls`
- Nested trigger: `role="menuitem"` (instead of button)
12 changes: 12 additions & 0 deletions packages/headless/src/primitives/menu/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
export * as Menu from './parts';

export type {
MenuArrowProps,
MenuItemProps,
MenuPopupProps,
MenuPortalProps,
MenuPositionerProps,
MenuProps,
MenuSeparatorProps,
MenuTriggerProps,
} from './parts';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/menu/menu-arrow.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
'use client';

import { FloatingArrow } from '@floating-ui/react';
import React from 'react';
import { useMenuContext } from './menu-context';

export interface MenuArrowProps extends React.ComponentPropsWithRef<typeof FloatingArrow> {}

export function MenuArrow(props: MenuArrowProps) {
const { floatingContext, arrowRef, placement } = useMenuContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='menu-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
40 changes: 40 additions & 0 deletions packages/headless/src/primitives/menu/menu-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type {
ExtendedRefs,
FloatingContext,
Placement,
ReferenceType,
UseInteractionsReturn,
} from '@floating-ui/react';
import { type CSSProperties, createContext, useContext } from 'react';
import type { TransitionProps } from '../../hooks/use-transition';

export interface MenuContextValue {
open: boolean;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
getItemProps: UseInteractionsReturn['getItemProps'];
activeIndex: number | null;
setActiveIndex: React.Dispatch<React.SetStateAction<number | null>>;
elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
labelsRef: React.MutableRefObject<Array<string | null>>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
popupRef: React.RefObject<HTMLDivElement | null>;
isNested: boolean;
mounted: boolean;
transitionProps: TransitionProps;
parentContext: MenuContextValue | null;
}

export const MenuContext = createContext<MenuContextValue | null>(null);

export function useMenuContext() {
const ctx = useContext(MenuContext);
if (!ctx) {
throw new Error('Menu compound components must be used within <Menu>');
}
return ctx;
}
52 changes: 52 additions & 0 deletions packages/headless/src/primitives/menu/menu-item.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
'use client';

import { useFloatingTree, useListItem } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuItemProps extends ComponentProps<'button'> {
label: string;
disabled?: boolean;
closeOnClick?: boolean;
}

export function MenuItem(props: MenuItemProps) {
const { render, label, disabled, closeOnClick = true, ...otherProps } = props;
const { activeIndex, getItemProps } = useMenuContext();
const tree = useFloatingTree();
const item = useListItem({ label: disabled ? null : label });
const isActive = item.index === activeIndex;

const state = {
active: isActive,
disabled: !!disabled,
};

const defaultProps = {
'data-cl-slot': 'menu-item',
type: 'button' as const,
ref: item.ref,
role: 'menuitem' as const,
tabIndex: isActive ? 0 : -1,
...(disabled && { 'aria-disabled': true as const }),
...(getItemProps({
onClick() {
if (!disabled && closeOnClick) {
tree?.events.emit('click');
}
},
}) as React.ComponentPropsWithRef<'button'>),
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
active: (v: boolean) => (v ? { 'data-cl-active': '' } : null),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/menu/menu-popup.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuPopupProps extends ComponentProps<'div'> {}

export function MenuPopup(props: MenuPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = useMenuContext();

const defaultProps = {
'data-cl-slot': 'menu-popup',
ref: popupRef,
...transitionProps,
};

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/menu/menu-portal.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
'use client';

import { FloatingPortal } from '@floating-ui/react';
import type { ReactNode } from 'react';
import { useMenuContext } from './menu-context';

export interface MenuPortalProps {
children: ReactNode;
root?: HTMLElement | null | React.RefObject<HTMLElement | null>;
}

export function MenuPortal(props: MenuPortalProps) {
const { mounted } = useMenuContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,10 @@
"import": "./dist/primitives/select/index.js",
"types": "./dist/primitives/select/index.d.ts"
},
"./menu": {
"import": "./dist/primitives/menu/index.js",
"types": "./dist/primitives/menu/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
157 changes: 157 additions & 0 deletions packages/headless/src/primitives/menu/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
# Menu

A dropdown menu with keyboard navigation, typeahead, and nested submenu support. Handles ARIA roles, safe hover zones for submenus, and tree-level close-on-click.

## When to Use

- Action menus, context menus, dropdown menus attached to a button trigger.
- When you need nested submenus with safe pointer zones between trigger and submenu.
- Prefer Menu over Popover when the content is a list of actions/commands rather than arbitrary content.

## Usage

```tsx
import { Menu } from '@/primitives/menu';

<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item
label='Edit'
onClick={() => handleEdit()}
/>
<Menu.Item
label='Duplicate'
onClick={() => handleDuplicate()}
/>
<Menu.Separator />
<Menu.Item
label='Delete'
onClick={() => handleDelete()}
/>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>;
```

### Nested Submenus

Nest a `<Menu.Root>` inside a parent `<Menu.Root>` — the nested trigger automatically renders as a `menuitem` and opens on hover with a safe polygon zone.

```tsx
<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Edit' />
<Menu.Root>
<Menu.Trigger>Share</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Copy Link' />
<Menu.Item label='Email' />
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
```

### Controlled

```tsx
const [open, setOpen] = useState(false);

<Menu.Root
open={open}
onOpenChange={setOpen}
>
{/* ... */}
</Menu.Root>;
```

## Parts

| Part | Default Element | Description |
| ----------------- | --------------- | -------------------------------------- |
| `Menu.Root` | — | Root context provider |
| `Menu.Trigger` | `<button>` | Opens/closes the menu |
| `Menu.Portal` | — | Portals children (accepts `root` prop) |
| `Menu.Positioner` | `<div>` | Floating positioned container |
| `Menu.Popup` | `<div>` | Visual wrapper for menu items |
| `Menu.Item` | `<button>` | A menu action item |
| `Menu.Separator` | `<div>` | Visual divider between items |
| `Menu.Arrow` | `<svg>` | Optional floating arrow |

## Props

### `Menu.Root`

| Prop | Type | Default | Description |
| -------------- | ------------------------- | ------------------------------------------------- | ---------------------------------- |
| `open` | `boolean` | — | Controlled open state |
| `defaultOpen` | `boolean` | `false` | Initial open state (uncontrolled) |
| `onOpenChange` | `(open: boolean) => void` | — | Called when open state changes |
| `placement` | `Placement` | `"bottom-start"` (root), `"right-start"` (nested) | Floating UI placement |
| `sideOffset` | `number` | `4` (root), `0` (nested) | Gap between trigger and popup (px) |

### `Menu.Item`

| Prop | Type | Default | Description |
| -------------- | --------- | ------------ | ------------------------------------------------------ |
| `label` | `string` | **required** | Item text, also used for typeahead matching |
| `disabled` | `boolean` | — | Prevents click handler, keeps item focusable |
| `closeOnClick` | `boolean` | `true` | Whether clicking this item closes the entire menu tree |

### `Menu.Trigger`, `Menu.Positioner`, `Menu.Popup`, `Menu.Separator`

No additional props beyond standard HTML attributes and the `render` prop.

### `Menu.Arrow`

Accepts all `FloatingArrow` props. `ref` and `context` are injected automatically.

## Keyboard Navigation

| Key | Action |
| ----------------- | -------------------------------------- |
| `ArrowDown` | Move to next item |
| `ArrowUp` | Move to previous item |
| `ArrowRight` | Open nested submenu |
| `ArrowLeft` | Close nested submenu, return to parent |
| `Enter` / `Space` | Activate the focused item |
| `Escape` | Close the current menu level |
| Type a character | Jump to matching item (typeahead) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ------------------------------------ |
| `data-cl-slot` | All parts | Part identifier (e.g. `"menu-item"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Menu open state |
| `data-cl-active` | Item | Keyboard-focused item |
| `data-cl-disabled` | Item | Disabled item |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Nested Menu Behavior

- Nested menus open on hover (75ms delay) with a `safePolygon` safe zone.
- Only one sibling submenu can be open at a time.
- Clicking any item with `closeOnClick={true}` (default) closes the entire menu tree via a tree event.
- `Escape` closes the innermost menu first, bubbling up through the tree.

## Important Notes

- **No built-in animations.** The positioner simply mounts/unmounts. Use `data-cl-open`/`data-cl-closed` for CSS-driven transitions.
- **Disabled items use `aria-disabled`, not `disabled`.** They remain focusable for keyboard users.
- **`label` is required on `Menu.Item`** — it drives typeahead matching. Disabled items are excluded from typeahead.

## ARIA

- Popup: `role="menu"`
- Item: `role="menuitem"`, `aria-disabled`
- Separator: `role="separator"`
- Trigger: `aria-expanded`, `aria-haspopup="menu"`, `aria-controls`
- Nested trigger: `role="menuitem"` (instead of button)
12 changes: 12 additions & 0 deletions packages/headless/src/primitives/menu/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
export * as Menu from './parts';

export type {
MenuArrowProps,
MenuItemProps,
MenuPopupProps,
MenuPortalProps,
MenuPositionerProps,
MenuProps,
MenuSeparatorProps,
MenuTriggerProps,
} from './parts';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/menu/menu-arrow.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
'use client';

import { FloatingArrow } from '@floating-ui/react';
import React from 'react';
import { useMenuContext } from './menu-context';

export interface MenuArrowProps extends React.ComponentPropsWithRef<typeof FloatingArrow> {}

export function MenuArrow(props: MenuArrowProps) {
const { floatingContext, arrowRef, placement } = useMenuContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='menu-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
40 changes: 40 additions & 0 deletions packages/headless/src/primitives/menu/menu-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type {
ExtendedRefs,
FloatingContext,
Placement,
ReferenceType,
UseInteractionsReturn,
} from '@floating-ui/react';
import { type CSSProperties, createContext, useContext } from 'react';
import type { TransitionProps } from '../../hooks/use-transition';

export interface MenuContextValue {
open: boolean;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
getItemProps: UseInteractionsReturn['getItemProps'];
activeIndex: number | null;
setActiveIndex: React.Dispatch<React.SetStateAction<number | null>>;
elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
labelsRef: React.MutableRefObject<Array<string | null>>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
popupRef: React.RefObject<HTMLDivElement | null>;
isNested: boolean;
mounted: boolean;
transitionProps: TransitionProps;
parentContext: MenuContextValue | null;
}

export const MenuContext = createContext<MenuContextValue | null>(null);

export function useMenuContext() {
const ctx = useContext(MenuContext);
if (!ctx) {
throw new Error('Menu compound components must be used within <Menu>');
}
return ctx;
}
52 changes: 52 additions & 0 deletions packages/headless/src/primitives/menu/menu-item.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
'use client';

import { useFloatingTree, useListItem } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuItemProps extends ComponentProps<'button'> {
label: string;
disabled?: boolean;
closeOnClick?: boolean;
}

export function MenuItem(props: MenuItemProps) {
const { render, label, disabled, closeOnClick = true, ...otherProps } = props;
const { activeIndex, getItemProps } = useMenuContext();
const tree = useFloatingTree();
const item = useListItem({ label: disabled ? null : label });
const isActive = item.index === activeIndex;

const state = {
active: isActive,
disabled: !!disabled,
};

const defaultProps = {
'data-cl-slot': 'menu-item',
type: 'button' as const,
ref: item.ref,
role: 'menuitem' as const,
tabIndex: isActive ? 0 : -1,
...(disabled && { 'aria-disabled': true as const }),
...(getItemProps({
onClick() {
if (!disabled && closeOnClick) {
tree?.events.emit('click');
}
},
}) as React.ComponentPropsWithRef<'button'>),
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
active: (v: boolean) => (v ? { 'data-cl-active': '' } : null),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/menu/menu-popup.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuPopupProps extends ComponentProps<'div'> {}

export function MenuPopup(props: MenuPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = useMenuContext();

const defaultProps = {
'data-cl-slot': 'menu-popup',
ref: popupRef,
...transitionProps,
};

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/menu/menu-portal.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
'use client';

import { FloatingPortal } from '@floating-ui/react';
import type { ReactNode } from 'react';
import { useMenuContext } from './menu-context';

export interface MenuPortalProps {
children: ReactNode;
root?: HTMLElement | null | React.RefObject<HTMLElement | null>;
}

export function MenuPortal(props: MenuPortalProps) {
const { mounted } = useMenuContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,10 @@
"import": "./dist/primitives/select/index.js",
"types": "./dist/primitives/select/index.d.ts"
},
"./menu": {
"import": "./dist/primitives/menu/index.js",
"types": "./dist/primitives/menu/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
157 changes: 157 additions & 0 deletions packages/headless/src/primitives/menu/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
# Menu

A dropdown menu with keyboard navigation, typeahead, and nested submenu support. Handles ARIA roles, safe hover zones for submenus, and tree-level close-on-click.

## When to Use

- Action menus, context menus, dropdown menus attached to a button trigger.
- When you need nested submenus with safe pointer zones between trigger and submenu.
- Prefer Menu over Popover when the content is a list of actions/commands rather than arbitrary content.

## Usage

```tsx
import { Menu } from '@/primitives/menu';

<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item
label='Edit'
onClick={() => handleEdit()}
/>
<Menu.Item
label='Duplicate'
onClick={() => handleDuplicate()}
/>
<Menu.Separator />
<Menu.Item
label='Delete'
onClick={() => handleDelete()}
/>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>;
```

### Nested Submenus

Nest a `<Menu.Root>` inside a parent `<Menu.Root>` — the nested trigger automatically renders as a `menuitem` and opens on hover with a safe polygon zone.

```tsx
<Menu.Root>
<Menu.Trigger>Actions</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Edit' />
<Menu.Root>
<Menu.Trigger>Share</Menu.Trigger>
<Menu.Positioner>
<Menu.Popup>
<Menu.Item label='Copy Link' />
<Menu.Item label='Email' />
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
</Menu.Popup>
</Menu.Positioner>
</Menu.Root>
```

### Controlled

```tsx
const [open, setOpen] = useState(false);

<Menu.Root
open={open}
onOpenChange={setOpen}
>
{/* ... */}
</Menu.Root>;
```

## Parts

| Part | Default Element | Description |
| ----------------- | --------------- | -------------------------------------- |
| `Menu.Root` | — | Root context provider |
| `Menu.Trigger` | `<button>` | Opens/closes the menu |
| `Menu.Portal` | — | Portals children (accepts `root` prop) |
| `Menu.Positioner` | `<div>` | Floating positioned container |
| `Menu.Popup` | `<div>` | Visual wrapper for menu items |
| `Menu.Item` | `<button>` | A menu action item |
| `Menu.Separator` | `<div>` | Visual divider between items |
| `Menu.Arrow` | `<svg>` | Optional floating arrow |

## Props

### `Menu.Root`

| Prop | Type | Default | Description |
| -------------- | ------------------------- | ------------------------------------------------- | ---------------------------------- |
| `open` | `boolean` | — | Controlled open state |
| `defaultOpen` | `boolean` | `false` | Initial open state (uncontrolled) |
| `onOpenChange` | `(open: boolean) => void` | — | Called when open state changes |
| `placement` | `Placement` | `"bottom-start"` (root), `"right-start"` (nested) | Floating UI placement |
| `sideOffset` | `number` | `4` (root), `0` (nested) | Gap between trigger and popup (px) |

### `Menu.Item`

| Prop | Type | Default | Description |
| -------------- | --------- | ------------ | ------------------------------------------------------ |
| `label` | `string` | **required** | Item text, also used for typeahead matching |
| `disabled` | `boolean` | — | Prevents click handler, keeps item focusable |
| `closeOnClick` | `boolean` | `true` | Whether clicking this item closes the entire menu tree |

### `Menu.Trigger`, `Menu.Positioner`, `Menu.Popup`, `Menu.Separator`

No additional props beyond standard HTML attributes and the `render` prop.

### `Menu.Arrow`

Accepts all `FloatingArrow` props. `ref` and `context` are injected automatically.

## Keyboard Navigation

| Key | Action |
| ----------------- | -------------------------------------- |
| `ArrowDown` | Move to next item |
| `ArrowUp` | Move to previous item |
| `ArrowRight` | Open nested submenu |
| `ArrowLeft` | Close nested submenu, return to parent |
| `Enter` / `Space` | Activate the focused item |
| `Escape` | Close the current menu level |
| Type a character | Jump to matching item (typeahead) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ------------------------------------ |
| `data-cl-slot` | All parts | Part identifier (e.g. `"menu-item"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Menu open state |
| `data-cl-active` | Item | Keyboard-focused item |
| `data-cl-disabled` | Item | Disabled item |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Nested Menu Behavior

- Nested menus open on hover (75ms delay) with a `safePolygon` safe zone.
- Only one sibling submenu can be open at a time.
- Clicking any item with `closeOnClick={true}` (default) closes the entire menu tree via a tree event.
- `Escape` closes the innermost menu first, bubbling up through the tree.

## Important Notes

- **No built-in animations.** The positioner simply mounts/unmounts. Use `data-cl-open`/`data-cl-closed` for CSS-driven transitions.
- **Disabled items use `aria-disabled`, not `disabled`.** They remain focusable for keyboard users.
- **`label` is required on `Menu.Item`** — it drives typeahead matching. Disabled items are excluded from typeahead.

## ARIA

- Popup: `role="menu"`
- Item: `role="menuitem"`, `aria-disabled`
- Separator: `role="separator"`
- Trigger: `aria-expanded`, `aria-haspopup="menu"`, `aria-controls`
- Nested trigger: `role="menuitem"` (instead of button)
12 changes: 12 additions & 0 deletions packages/headless/src/primitives/menu/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
export * as Menu from './parts';

export type {
MenuArrowProps,
MenuItemProps,
MenuPopupProps,
MenuPortalProps,
MenuPositionerProps,
MenuProps,
MenuSeparatorProps,
MenuTriggerProps,
} from './parts';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/menu/menu-arrow.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
'use client';

import { FloatingArrow } from '@floating-ui/react';
import React from 'react';
import { useMenuContext } from './menu-context';

export interface MenuArrowProps extends React.ComponentPropsWithRef<typeof FloatingArrow> {}

export function MenuArrow(props: MenuArrowProps) {
const { floatingContext, arrowRef, placement } = useMenuContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='menu-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
40 changes: 40 additions & 0 deletions packages/headless/src/primitives/menu/menu-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type {
ExtendedRefs,
FloatingContext,
Placement,
ReferenceType,
UseInteractionsReturn,
} from '@floating-ui/react';
import { type CSSProperties, createContext, useContext } from 'react';
import type { TransitionProps } from '../../hooks/use-transition';

export interface MenuContextValue {
open: boolean;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
getItemProps: UseInteractionsReturn['getItemProps'];
activeIndex: number | null;
setActiveIndex: React.Dispatch<React.SetStateAction<number | null>>;
elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
labelsRef: React.MutableRefObject<Array<string | null>>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
popupRef: React.RefObject<HTMLDivElement | null>;
isNested: boolean;
mounted: boolean;
transitionProps: TransitionProps;
parentContext: MenuContextValue | null;
}

export const MenuContext = createContext<MenuContextValue | null>(null);

export function useMenuContext() {
const ctx = useContext(MenuContext);
if (!ctx) {
throw new Error('Menu compound components must be used within <Menu>');
}
return ctx;
}
52 changes: 52 additions & 0 deletions packages/headless/src/primitives/menu/menu-item.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
'use client';

import { useFloatingTree, useListItem } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuItemProps extends ComponentProps<'button'> {
label: string;
disabled?: boolean;
closeOnClick?: boolean;
}

export function MenuItem(props: MenuItemProps) {
const { render, label, disabled, closeOnClick = true, ...otherProps } = props;
const { activeIndex, getItemProps } = useMenuContext();
const tree = useFloatingTree();
const item = useListItem({ label: disabled ? null : label });
const isActive = item.index === activeIndex;

const state = {
active: isActive,
disabled: !!disabled,
};

const defaultProps = {
'data-cl-slot': 'menu-item',
type: 'button' as const,
ref: item.ref,
role: 'menuitem' as const,
tabIndex: isActive ? 0 : -1,
...(disabled && { 'aria-disabled': true as const }),
...(getItemProps({
onClick() {
if (!disabled && closeOnClick) {
tree?.events.emit('click');
}
},
}) as React.ComponentPropsWithRef<'button'>),
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
active: (v: boolean) => (v ? { 'data-cl-active': '' } : null),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/menu/menu-popup.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useMenuContext } from './menu-context';

export interface MenuPopupProps extends ComponentProps<'div'> {}

export function MenuPopup(props: MenuPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = useMenuContext();

const defaultProps = {
'data-cl-slot': 'menu-popup',
ref: popupRef,
...transitionProps,
};

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/menu/menu-portal.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
'use client';

import { FloatingPortal } from '@floating-ui/react';
import type { ReactNode } from 'react';
import { useMenuContext } from './menu-context';

export interface MenuPortalProps {
children: ReactNode;
root?: HTMLElement | null | React.RefObject<HTMLElement | null>;
}

export function MenuPortal(props: MenuPortalProps) {
const { mounted } = useMenuContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
Loading
Loading