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@@ -17,6 +17,10 @@
"import": "./dist/primitives/tooltip/index.js",
"types": "./dist/primitives/tooltip/index.d.ts"
},
"./popover": {
"import": "./dist/primitives/popover/index.js",
"types": "./dist/primitives/popover/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
111 changes: 111 additions & 0 deletions packages/headless/src/primitives/popover/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
# Popover

A floating panel anchored to a trigger element. Supports focus management, ARIA labeling, and enter/exit animations.

## When to Use

- Rich content panels, filter dropdowns, or any non-modal floating content anchored to a trigger.
- When content includes interactive elements (inputs, buttons) — unlike Tooltip which is display-only.
- Prefer Popover over Dialog when the content should be anchored to a specific element and the page should remain interactive by default.

## Usage

```tsx
import { Popover } from '@/primitives/popover';

<Popover.Root>
<Popover.Trigger>Settings</Popover.Trigger>
<Popover.Positioner>
<Popover.Popup>
<Popover.Title>Preferences</Popover.Title>
<Popover.Description>Adjust your settings below.</Popover.Description>
{/* Interactive content here */}
<Popover.Close>Done</Popover.Close>
</Popover.Popup>
</Popover.Positioner>
</Popover.Root>;
```

### Controlled

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

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

### Modal Mode

```tsx
<Popover.Root modal>{/* Focus is trapped within the popover */}</Popover.Root>
```

## Parts

| Part | Default Element | Description |
| --------------------- | --------------- | ---------------------------------------- |
| `Popover.Root` | — | Root context provider |
| `Popover.Trigger` | `<button>` | Toggles the popover on click |
| `Popover.Portal` | — | Portals children (accepts `root` prop) |
| `Popover.Positioner` | `<div>` | Floating positioned container |
| `Popover.Popup` | `<div>` | Visual content wrapper |
| `Popover.Arrow` | `<svg>` | Optional floating arrow |
| `Popover.Title` | `<h2>` | Heading, wired to `aria-labelledby` |
| `Popover.Description` | `<p>` | Description, wired to `aria-describedby` |
| `Popover.Close` | `<button>` | Closes the popover on click |

## Props

### `Popover.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"` | Floating UI placement |
| `sideOffset` | `number` | `4` | Gap between trigger and popup (px) |
| `modal` | `boolean` | `false` | Traps focus within the popover |

### `Popover.Trigger`, `Popover.Positioner`, `Popover.Popup`, `Popover.Title`, `Popover.Description`, `Popover.Close`

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

### `Popover.Arrow`

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

## Keyboard

| Key | Action |
| -------- | -------------------------------------------------------------------- |
| `Escape` | Closes the popover |
| `Tab` | Cycles focus within popover (modal mode) or moves freely (non-modal) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ---------------------------------------- |
| `data-cl-slot` | All parts | Part identifier (e.g. `"popover-popup"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Open state |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Positioning

Middleware stack: `offset` -> `flip` -> `shift` -> `arrow` -> CSS vars. The popup auto-repositions on scroll and resize via `autoUpdate`. Cross-axis flipping is enabled only when using an aligned placement (e.g. `"bottom-start"`).

## Important Notes

- **Title and Description are optional but recommended.** They wire `aria-labelledby` and `aria-describedby` to the positioner. If omitted, those attributes are simply absent.
- **Non-modal by default.** Unlike Dialog, the page remains interactive behind the popover. Set `modal={true}` for a stricter focus trap.
- **Nested popovers are supported.** The `FloatingTree` pattern handles nesting automatically.

## ARIA

- Positioner: `role="dialog"`, `aria-labelledby` (from Title), `aria-describedby` (from Description)
- Trigger: `aria-expanded`, `aria-haspopup="dialog"`, `aria-controls`
13 changes: 13 additions & 0 deletions packages/headless/src/primitives/popover/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
export * as Popover from './parts';

export type {
PopoverArrowProps,
PopoverCloseProps,
PopoverDescriptionProps,
PopoverPopupProps,
PopoverPortalProps,
PopoverPositionerProps,
PopoverProps,
PopoverTitleProps,
PopoverTriggerProps,
} from './parts';
9 changes: 9 additions & 0 deletions packages/headless/src/primitives/popover/parts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
export { type PopoverProps, PopoverRoot as Root } from './popover-root';
export { type PopoverTriggerProps, PopoverTrigger as Trigger } from './popover-trigger';
export { type PopoverPortalProps, PopoverPortal as Portal } from './popover-portal';
export { type PopoverPositionerProps, PopoverPositioner as Positioner } from './popover-positioner';
export { type PopoverPopupProps, PopoverPopup as Popup } from './popover-popup';
export { type PopoverArrowProps, PopoverArrow as Arrow } from './popover-arrow';
export { type PopoverTitleProps, PopoverTitle as Title } from './popover-title';
export { type PopoverDescriptionProps, PopoverDescription as Description } from './popover-description';
export { type PopoverCloseProps, PopoverClose as Close } from './popover-close';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverArrow(props: PopoverArrowProps) {
const { floatingContext, arrowRef, placement } = usePopoverContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='popover-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
25 changes: 25 additions & 0 deletions packages/headless/src/primitives/popover/popover-close.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
'use client';

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

export interface PopoverCloseProps extends ComponentProps<'button'> {}

export function PopoverClose(props: PopoverCloseProps) {
const { render, ...otherProps } = props;
const { setOpen } = usePopoverContext();

const defaultProps = {
type: 'button' as const,
'data-cl-slot': 'popover-close',
onClick() {
setOpen(false);
},
};

return renderElement({
defaultTagName: 'button',
render,
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
39 changes: 39 additions & 0 deletions packages/headless/src/primitives/popover/popover-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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 PopoverContextValue {
open: boolean;
setOpen: (open: boolean) => void;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
popupRef: React.RefObject<HTMLDivElement | null>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
modal: boolean;
labelId: string | undefined;
descriptionId: string | undefined;
setLabelId: React.Dispatch<React.SetStateAction<string | undefined>>;
setDescriptionId: React.Dispatch<React.SetStateAction<string | undefined>>;
mounted: boolean;
transitionProps: TransitionProps;
}

export const PopoverContext = createContext<PopoverContextValue | null>(null);

export function usePopoverContext() {
const ctx = useContext(PopoverContext);
if (!ctx) {
throw new Error('Popover compound components must be used within <Popover.Root>');
}
return ctx;
}
29 changes: 29 additions & 0 deletions packages/headless/src/primitives/popover/popover-description.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
'use client';

import { useId, useLayoutEffect } from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

export interface PopoverDescriptionProps extends ComponentProps<'p'> {}

export function PopoverDescription(props: PopoverDescriptionProps) {
const { render, ...otherProps } = props;
const { setDescriptionId } = usePopoverContext();
const id = useId();

useLayoutEffect(() => {
setDescriptionId(id);
return () => setDescriptionId(undefined);
}, [id, setDescriptionId]);

const defaultProps = {
'data-cl-slot': 'popover-description',
id,
};

return renderElement({
defaultTagName: 'p',
render,
props: mergeProps<'p'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPopup(props: PopoverPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = usePopoverContext();

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

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPortal(props: PopoverPortalProps) {
const { mounted } = usePopoverContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
42 changes: 42 additions & 0 deletions packages/headless/src/primitives/popover/popover-positioner.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
'use client';

import { FloatingFocusManager } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

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

export function PopoverPositioner(props: PopoverPositionerProps) {
const { render, ...otherProps } = props;
const { mounted, floatingContext, refs, floatingStyles, placement, getFloatingProps, modal, labelId, descriptionId } =
usePopoverContext();

const side = placement.split('-')[0];

const defaultProps = {
'data-cl-slot': 'popover-positioner',
'data-cl-side': side,
ref: refs.setFloating,
style: floatingStyles,
'aria-labelledby': labelId,
'aria-describedby': descriptionId,
...(getFloatingProps() as React.ComponentPropsWithRef<'div'>),
};

const element = renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
props: mergeProps<'div'>(defaultProps, otherProps),
});

return (
<FloatingFocusManager
context={floatingContext}
modal={modal}
>
{element!}
</FloatingFocusManager>
);
}
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" + '
feat(headless): add Popover primitive by alexcarpenter · Pull Request #8478 · clerk/javascript · GitHub
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@@ -17,6 +17,10 @@
"import": "./dist/primitives/tooltip/index.js",
"types": "./dist/primitives/tooltip/index.d.ts"
},
"./popover": {
"import": "./dist/primitives/popover/index.js",
"types": "./dist/primitives/popover/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
111 changes: 111 additions & 0 deletions packages/headless/src/primitives/popover/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
# Popover

A floating panel anchored to a trigger element. Supports focus management, ARIA labeling, and enter/exit animations.

## When to Use

- Rich content panels, filter dropdowns, or any non-modal floating content anchored to a trigger.
- When content includes interactive elements (inputs, buttons) — unlike Tooltip which is display-only.
- Prefer Popover over Dialog when the content should be anchored to a specific element and the page should remain interactive by default.

## Usage

```tsx
import { Popover } from '@/primitives/popover';

<Popover.Root>
<Popover.Trigger>Settings</Popover.Trigger>
<Popover.Positioner>
<Popover.Popup>
<Popover.Title>Preferences</Popover.Title>
<Popover.Description>Adjust your settings below.</Popover.Description>
{/* Interactive content here */}
<Popover.Close>Done</Popover.Close>
</Popover.Popup>
</Popover.Positioner>
</Popover.Root>;
```

### Controlled

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

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

### Modal Mode

```tsx
<Popover.Root modal>{/* Focus is trapped within the popover */}</Popover.Root>
```

## Parts

| Part | Default Element | Description |
| --------------------- | --------------- | ---------------------------------------- |
| `Popover.Root` | — | Root context provider |
| `Popover.Trigger` | `<button>` | Toggles the popover on click |
| `Popover.Portal` | — | Portals children (accepts `root` prop) |
| `Popover.Positioner` | `<div>` | Floating positioned container |
| `Popover.Popup` | `<div>` | Visual content wrapper |
| `Popover.Arrow` | `<svg>` | Optional floating arrow |
| `Popover.Title` | `<h2>` | Heading, wired to `aria-labelledby` |
| `Popover.Description` | `<p>` | Description, wired to `aria-describedby` |
| `Popover.Close` | `<button>` | Closes the popover on click |

## Props

### `Popover.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"` | Floating UI placement |
| `sideOffset` | `number` | `4` | Gap between trigger and popup (px) |
| `modal` | `boolean` | `false` | Traps focus within the popover |

### `Popover.Trigger`, `Popover.Positioner`, `Popover.Popup`, `Popover.Title`, `Popover.Description`, `Popover.Close`

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

### `Popover.Arrow`

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

## Keyboard

| Key | Action |
| -------- | -------------------------------------------------------------------- |
| `Escape` | Closes the popover |
| `Tab` | Cycles focus within popover (modal mode) or moves freely (non-modal) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ---------------------------------------- |
| `data-cl-slot` | All parts | Part identifier (e.g. `"popover-popup"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Open state |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Positioning

Middleware stack: `offset` -> `flip` -> `shift` -> `arrow` -> CSS vars. The popup auto-repositions on scroll and resize via `autoUpdate`. Cross-axis flipping is enabled only when using an aligned placement (e.g. `"bottom-start"`).

## Important Notes

- **Title and Description are optional but recommended.** They wire `aria-labelledby` and `aria-describedby` to the positioner. If omitted, those attributes are simply absent.
- **Non-modal by default.** Unlike Dialog, the page remains interactive behind the popover. Set `modal={true}` for a stricter focus trap.
- **Nested popovers are supported.** The `FloatingTree` pattern handles nesting automatically.

## ARIA

- Positioner: `role="dialog"`, `aria-labelledby` (from Title), `aria-describedby` (from Description)
- Trigger: `aria-expanded`, `aria-haspopup="dialog"`, `aria-controls`
13 changes: 13 additions & 0 deletions packages/headless/src/primitives/popover/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
export * as Popover from './parts';

export type {
PopoverArrowProps,
PopoverCloseProps,
PopoverDescriptionProps,
PopoverPopupProps,
PopoverPortalProps,
PopoverPositionerProps,
PopoverProps,
PopoverTitleProps,
PopoverTriggerProps,
} from './parts';
9 changes: 9 additions & 0 deletions packages/headless/src/primitives/popover/parts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
export { type PopoverProps, PopoverRoot as Root } from './popover-root';
export { type PopoverTriggerProps, PopoverTrigger as Trigger } from './popover-trigger';
export { type PopoverPortalProps, PopoverPortal as Portal } from './popover-portal';
export { type PopoverPositionerProps, PopoverPositioner as Positioner } from './popover-positioner';
export { type PopoverPopupProps, PopoverPopup as Popup } from './popover-popup';
export { type PopoverArrowProps, PopoverArrow as Arrow } from './popover-arrow';
export { type PopoverTitleProps, PopoverTitle as Title } from './popover-title';
export { type PopoverDescriptionProps, PopoverDescription as Description } from './popover-description';
export { type PopoverCloseProps, PopoverClose as Close } from './popover-close';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverArrow(props: PopoverArrowProps) {
const { floatingContext, arrowRef, placement } = usePopoverContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='popover-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
25 changes: 25 additions & 0 deletions packages/headless/src/primitives/popover/popover-close.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
'use client';

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

export interface PopoverCloseProps extends ComponentProps<'button'> {}

export function PopoverClose(props: PopoverCloseProps) {
const { render, ...otherProps } = props;
const { setOpen } = usePopoverContext();

const defaultProps = {
type: 'button' as const,
'data-cl-slot': 'popover-close',
onClick() {
setOpen(false);
},
};

return renderElement({
defaultTagName: 'button',
render,
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
39 changes: 39 additions & 0 deletions packages/headless/src/primitives/popover/popover-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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 PopoverContextValue {
open: boolean;
setOpen: (open: boolean) => void;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
popupRef: React.RefObject<HTMLDivElement | null>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
modal: boolean;
labelId: string | undefined;
descriptionId: string | undefined;
setLabelId: React.Dispatch<React.SetStateAction<string | undefined>>;
setDescriptionId: React.Dispatch<React.SetStateAction<string | undefined>>;
mounted: boolean;
transitionProps: TransitionProps;
}

export const PopoverContext = createContext<PopoverContextValue | null>(null);

export function usePopoverContext() {
const ctx = useContext(PopoverContext);
if (!ctx) {
throw new Error('Popover compound components must be used within <Popover.Root>');
}
return ctx;
}
29 changes: 29 additions & 0 deletions packages/headless/src/primitives/popover/popover-description.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
'use client';

import { useId, useLayoutEffect } from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

export interface PopoverDescriptionProps extends ComponentProps<'p'> {}

export function PopoverDescription(props: PopoverDescriptionProps) {
const { render, ...otherProps } = props;
const { setDescriptionId } = usePopoverContext();
const id = useId();

useLayoutEffect(() => {
setDescriptionId(id);
return () => setDescriptionId(undefined);
}, [id, setDescriptionId]);

const defaultProps = {
'data-cl-slot': 'popover-description',
id,
};

return renderElement({
defaultTagName: 'p',
render,
props: mergeProps<'p'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPopup(props: PopoverPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = usePopoverContext();

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

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPortal(props: PopoverPortalProps) {
const { mounted } = usePopoverContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
42 changes: 42 additions & 0 deletions packages/headless/src/primitives/popover/popover-positioner.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
'use client';

import { FloatingFocusManager } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

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

export function PopoverPositioner(props: PopoverPositionerProps) {
const { render, ...otherProps } = props;
const { mounted, floatingContext, refs, floatingStyles, placement, getFloatingProps, modal, labelId, descriptionId } =
usePopoverContext();

const side = placement.split('-')[0];

const defaultProps = {
'data-cl-slot': 'popover-positioner',
'data-cl-side': side,
ref: refs.setFloating,
style: floatingStyles,
'aria-labelledby': labelId,
'aria-describedby': descriptionId,
...(getFloatingProps() as React.ComponentPropsWithRef<'div'>),
};

const element = renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
props: mergeProps<'div'>(defaultProps, otherProps),
});

return (
<FloatingFocusManager
context={floatingContext}
modal={modal}
>
{element!}
</FloatingFocusManager>
);
}
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('^' + ".*" + ' feat(headless): add Popover primitive by alexcarpenter · Pull Request #8478 · clerk/javascript · GitHub
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@@ -17,6 +17,10 @@
"import": "./dist/primitives/tooltip/index.js",
"types": "./dist/primitives/tooltip/index.d.ts"
},
"./popover": {
"import": "./dist/primitives/popover/index.js",
"types": "./dist/primitives/popover/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
111 changes: 111 additions & 0 deletions packages/headless/src/primitives/popover/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
# Popover

A floating panel anchored to a trigger element. Supports focus management, ARIA labeling, and enter/exit animations.

## When to Use

- Rich content panels, filter dropdowns, or any non-modal floating content anchored to a trigger.
- When content includes interactive elements (inputs, buttons) — unlike Tooltip which is display-only.
- Prefer Popover over Dialog when the content should be anchored to a specific element and the page should remain interactive by default.

## Usage

```tsx
import { Popover } from '@/primitives/popover';

<Popover.Root>
<Popover.Trigger>Settings</Popover.Trigger>
<Popover.Positioner>
<Popover.Popup>
<Popover.Title>Preferences</Popover.Title>
<Popover.Description>Adjust your settings below.</Popover.Description>
{/* Interactive content here */}
<Popover.Close>Done</Popover.Close>
</Popover.Popup>
</Popover.Positioner>
</Popover.Root>;
```

### Controlled

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

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

### Modal Mode

```tsx
<Popover.Root modal>{/* Focus is trapped within the popover */}</Popover.Root>
```

## Parts

| Part | Default Element | Description |
| --------------------- | --------------- | ---------------------------------------- |
| `Popover.Root` | — | Root context provider |
| `Popover.Trigger` | `<button>` | Toggles the popover on click |
| `Popover.Portal` | — | Portals children (accepts `root` prop) |
| `Popover.Positioner` | `<div>` | Floating positioned container |
| `Popover.Popup` | `<div>` | Visual content wrapper |
| `Popover.Arrow` | `<svg>` | Optional floating arrow |
| `Popover.Title` | `<h2>` | Heading, wired to `aria-labelledby` |
| `Popover.Description` | `<p>` | Description, wired to `aria-describedby` |
| `Popover.Close` | `<button>` | Closes the popover on click |

## Props

### `Popover.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"` | Floating UI placement |
| `sideOffset` | `number` | `4` | Gap between trigger and popup (px) |
| `modal` | `boolean` | `false` | Traps focus within the popover |

### `Popover.Trigger`, `Popover.Positioner`, `Popover.Popup`, `Popover.Title`, `Popover.Description`, `Popover.Close`

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

### `Popover.Arrow`

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

## Keyboard

| Key | Action |
| -------- | -------------------------------------------------------------------- |
| `Escape` | Closes the popover |
| `Tab` | Cycles focus within popover (modal mode) or moves freely (non-modal) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ---------------------------------------- |
| `data-cl-slot` | All parts | Part identifier (e.g. `"popover-popup"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Open state |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Positioning

Middleware stack: `offset` -> `flip` -> `shift` -> `arrow` -> CSS vars. The popup auto-repositions on scroll and resize via `autoUpdate`. Cross-axis flipping is enabled only when using an aligned placement (e.g. `"bottom-start"`).

## Important Notes

- **Title and Description are optional but recommended.** They wire `aria-labelledby` and `aria-describedby` to the positioner. If omitted, those attributes are simply absent.
- **Non-modal by default.** Unlike Dialog, the page remains interactive behind the popover. Set `modal={true}` for a stricter focus trap.
- **Nested popovers are supported.** The `FloatingTree` pattern handles nesting automatically.

## ARIA

- Positioner: `role="dialog"`, `aria-labelledby` (from Title), `aria-describedby` (from Description)
- Trigger: `aria-expanded`, `aria-haspopup="dialog"`, `aria-controls`
13 changes: 13 additions & 0 deletions packages/headless/src/primitives/popover/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
export * as Popover from './parts';

export type {
PopoverArrowProps,
PopoverCloseProps,
PopoverDescriptionProps,
PopoverPopupProps,
PopoverPortalProps,
PopoverPositionerProps,
PopoverProps,
PopoverTitleProps,
PopoverTriggerProps,
} from './parts';
9 changes: 9 additions & 0 deletions packages/headless/src/primitives/popover/parts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
export { type PopoverProps, PopoverRoot as Root } from './popover-root';
export { type PopoverTriggerProps, PopoverTrigger as Trigger } from './popover-trigger';
export { type PopoverPortalProps, PopoverPortal as Portal } from './popover-portal';
export { type PopoverPositionerProps, PopoverPositioner as Positioner } from './popover-positioner';
export { type PopoverPopupProps, PopoverPopup as Popup } from './popover-popup';
export { type PopoverArrowProps, PopoverArrow as Arrow } from './popover-arrow';
export { type PopoverTitleProps, PopoverTitle as Title } from './popover-title';
export { type PopoverDescriptionProps, PopoverDescription as Description } from './popover-description';
export { type PopoverCloseProps, PopoverClose as Close } from './popover-close';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverArrow(props: PopoverArrowProps) {
const { floatingContext, arrowRef, placement } = usePopoverContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='popover-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
25 changes: 25 additions & 0 deletions packages/headless/src/primitives/popover/popover-close.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
'use client';

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

export interface PopoverCloseProps extends ComponentProps<'button'> {}

export function PopoverClose(props: PopoverCloseProps) {
const { render, ...otherProps } = props;
const { setOpen } = usePopoverContext();

const defaultProps = {
type: 'button' as const,
'data-cl-slot': 'popover-close',
onClick() {
setOpen(false);
},
};

return renderElement({
defaultTagName: 'button',
render,
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
39 changes: 39 additions & 0 deletions packages/headless/src/primitives/popover/popover-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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 PopoverContextValue {
open: boolean;
setOpen: (open: boolean) => void;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
popupRef: React.RefObject<HTMLDivElement | null>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
modal: boolean;
labelId: string | undefined;
descriptionId: string | undefined;
setLabelId: React.Dispatch<React.SetStateAction<string | undefined>>;
setDescriptionId: React.Dispatch<React.SetStateAction<string | undefined>>;
mounted: boolean;
transitionProps: TransitionProps;
}

export const PopoverContext = createContext<PopoverContextValue | null>(null);

export function usePopoverContext() {
const ctx = useContext(PopoverContext);
if (!ctx) {
throw new Error('Popover compound components must be used within <Popover.Root>');
}
return ctx;
}
29 changes: 29 additions & 0 deletions packages/headless/src/primitives/popover/popover-description.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
'use client';

import { useId, useLayoutEffect } from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

export interface PopoverDescriptionProps extends ComponentProps<'p'> {}

export function PopoverDescription(props: PopoverDescriptionProps) {
const { render, ...otherProps } = props;
const { setDescriptionId } = usePopoverContext();
const id = useId();

useLayoutEffect(() => {
setDescriptionId(id);
return () => setDescriptionId(undefined);
}, [id, setDescriptionId]);

const defaultProps = {
'data-cl-slot': 'popover-description',
id,
};

return renderElement({
defaultTagName: 'p',
render,
props: mergeProps<'p'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPopup(props: PopoverPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = usePopoverContext();

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

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPortal(props: PopoverPortalProps) {
const { mounted } = usePopoverContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
42 changes: 42 additions & 0 deletions packages/headless/src/primitives/popover/popover-positioner.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
'use client';

import { FloatingFocusManager } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

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

export function PopoverPositioner(props: PopoverPositionerProps) {
const { render, ...otherProps } = props;
const { mounted, floatingContext, refs, floatingStyles, placement, getFloatingProps, modal, labelId, descriptionId } =
usePopoverContext();

const side = placement.split('-')[0];

const defaultProps = {
'data-cl-slot': 'popover-positioner',
'data-cl-side': side,
ref: refs.setFloating,
style: floatingStyles,
'aria-labelledby': labelId,
'aria-describedby': descriptionId,
...(getFloatingProps() as React.ComponentPropsWithRef<'div'>),
};

const element = renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
props: mergeProps<'div'>(defaultProps, otherProps),
});

return (
<FloatingFocusManager
context={floatingContext}
modal={modal}
>
{element!}
</FloatingFocusManager>
);
}
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('^' + ".*" + ' feat(headless): add Popover primitive by alexcarpenter · Pull Request #8478 · clerk/javascript · GitHub
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@@ -17,6 +17,10 @@
"import": "./dist/primitives/tooltip/index.js",
"types": "./dist/primitives/tooltip/index.d.ts"
},
"./popover": {
"import": "./dist/primitives/popover/index.js",
"types": "./dist/primitives/popover/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
111 changes: 111 additions & 0 deletions packages/headless/src/primitives/popover/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
# Popover

A floating panel anchored to a trigger element. Supports focus management, ARIA labeling, and enter/exit animations.

## When to Use

- Rich content panels, filter dropdowns, or any non-modal floating content anchored to a trigger.
- When content includes interactive elements (inputs, buttons) — unlike Tooltip which is display-only.
- Prefer Popover over Dialog when the content should be anchored to a specific element and the page should remain interactive by default.

## Usage

```tsx
import { Popover } from '@/primitives/popover';

<Popover.Root>
<Popover.Trigger>Settings</Popover.Trigger>
<Popover.Positioner>
<Popover.Popup>
<Popover.Title>Preferences</Popover.Title>
<Popover.Description>Adjust your settings below.</Popover.Description>
{/* Interactive content here */}
<Popover.Close>Done</Popover.Close>
</Popover.Popup>
</Popover.Positioner>
</Popover.Root>;
```

### Controlled

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

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

### Modal Mode

```tsx
<Popover.Root modal>{/* Focus is trapped within the popover */}</Popover.Root>
```

## Parts

| Part | Default Element | Description |
| --------------------- | --------------- | ---------------------------------------- |
| `Popover.Root` | — | Root context provider |
| `Popover.Trigger` | `<button>` | Toggles the popover on click |
| `Popover.Portal` | — | Portals children (accepts `root` prop) |
| `Popover.Positioner` | `<div>` | Floating positioned container |
| `Popover.Popup` | `<div>` | Visual content wrapper |
| `Popover.Arrow` | `<svg>` | Optional floating arrow |
| `Popover.Title` | `<h2>` | Heading, wired to `aria-labelledby` |
| `Popover.Description` | `<p>` | Description, wired to `aria-describedby` |
| `Popover.Close` | `<button>` | Closes the popover on click |

## Props

### `Popover.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"` | Floating UI placement |
| `sideOffset` | `number` | `4` | Gap between trigger and popup (px) |
| `modal` | `boolean` | `false` | Traps focus within the popover |

### `Popover.Trigger`, `Popover.Positioner`, `Popover.Popup`, `Popover.Title`, `Popover.Description`, `Popover.Close`

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

### `Popover.Arrow`

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

## Keyboard

| Key | Action |
| -------- | -------------------------------------------------------------------- |
| `Escape` | Closes the popover |
| `Tab` | Cycles focus within popover (modal mode) or moves freely (non-modal) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ---------------------------------------- |
| `data-cl-slot` | All parts | Part identifier (e.g. `"popover-popup"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Open state |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Positioning

Middleware stack: `offset` -> `flip` -> `shift` -> `arrow` -> CSS vars. The popup auto-repositions on scroll and resize via `autoUpdate`. Cross-axis flipping is enabled only when using an aligned placement (e.g. `"bottom-start"`).

## Important Notes

- **Title and Description are optional but recommended.** They wire `aria-labelledby` and `aria-describedby` to the positioner. If omitted, those attributes are simply absent.
- **Non-modal by default.** Unlike Dialog, the page remains interactive behind the popover. Set `modal={true}` for a stricter focus trap.
- **Nested popovers are supported.** The `FloatingTree` pattern handles nesting automatically.

## ARIA

- Positioner: `role="dialog"`, `aria-labelledby` (from Title), `aria-describedby` (from Description)
- Trigger: `aria-expanded`, `aria-haspopup="dialog"`, `aria-controls`
13 changes: 13 additions & 0 deletions packages/headless/src/primitives/popover/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
export * as Popover from './parts';

export type {
PopoverArrowProps,
PopoverCloseProps,
PopoverDescriptionProps,
PopoverPopupProps,
PopoverPortalProps,
PopoverPositionerProps,
PopoverProps,
PopoverTitleProps,
PopoverTriggerProps,
} from './parts';
9 changes: 9 additions & 0 deletions packages/headless/src/primitives/popover/parts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
export { type PopoverProps, PopoverRoot as Root } from './popover-root';
export { type PopoverTriggerProps, PopoverTrigger as Trigger } from './popover-trigger';
export { type PopoverPortalProps, PopoverPortal as Portal } from './popover-portal';
export { type PopoverPositionerProps, PopoverPositioner as Positioner } from './popover-positioner';
export { type PopoverPopupProps, PopoverPopup as Popup } from './popover-popup';
export { type PopoverArrowProps, PopoverArrow as Arrow } from './popover-arrow';
export { type PopoverTitleProps, PopoverTitle as Title } from './popover-title';
export { type PopoverDescriptionProps, PopoverDescription as Description } from './popover-description';
export { type PopoverCloseProps, PopoverClose as Close } from './popover-close';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverArrow(props: PopoverArrowProps) {
const { floatingContext, arrowRef, placement } = usePopoverContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='popover-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
25 changes: 25 additions & 0 deletions packages/headless/src/primitives/popover/popover-close.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
'use client';

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

export interface PopoverCloseProps extends ComponentProps<'button'> {}

export function PopoverClose(props: PopoverCloseProps) {
const { render, ...otherProps } = props;
const { setOpen } = usePopoverContext();

const defaultProps = {
type: 'button' as const,
'data-cl-slot': 'popover-close',
onClick() {
setOpen(false);
},
};

return renderElement({
defaultTagName: 'button',
render,
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
39 changes: 39 additions & 0 deletions packages/headless/src/primitives/popover/popover-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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 PopoverContextValue {
open: boolean;
setOpen: (open: boolean) => void;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
popupRef: React.RefObject<HTMLDivElement | null>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
modal: boolean;
labelId: string | undefined;
descriptionId: string | undefined;
setLabelId: React.Dispatch<React.SetStateAction<string | undefined>>;
setDescriptionId: React.Dispatch<React.SetStateAction<string | undefined>>;
mounted: boolean;
transitionProps: TransitionProps;
}

export const PopoverContext = createContext<PopoverContextValue | null>(null);

export function usePopoverContext() {
const ctx = useContext(PopoverContext);
if (!ctx) {
throw new Error('Popover compound components must be used within <Popover.Root>');
}
return ctx;
}
29 changes: 29 additions & 0 deletions packages/headless/src/primitives/popover/popover-description.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
'use client';

import { useId, useLayoutEffect } from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

export interface PopoverDescriptionProps extends ComponentProps<'p'> {}

export function PopoverDescription(props: PopoverDescriptionProps) {
const { render, ...otherProps } = props;
const { setDescriptionId } = usePopoverContext();
const id = useId();

useLayoutEffect(() => {
setDescriptionId(id);
return () => setDescriptionId(undefined);
}, [id, setDescriptionId]);

const defaultProps = {
'data-cl-slot': 'popover-description',
id,
};

return renderElement({
defaultTagName: 'p',
render,
props: mergeProps<'p'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPopup(props: PopoverPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = usePopoverContext();

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

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPortal(props: PopoverPortalProps) {
const { mounted } = usePopoverContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
42 changes: 42 additions & 0 deletions packages/headless/src/primitives/popover/popover-positioner.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
'use client';

import { FloatingFocusManager } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

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

export function PopoverPositioner(props: PopoverPositionerProps) {
const { render, ...otherProps } = props;
const { mounted, floatingContext, refs, floatingStyles, placement, getFloatingProps, modal, labelId, descriptionId } =
usePopoverContext();

const side = placement.split('-')[0];

const defaultProps = {
'data-cl-slot': 'popover-positioner',
'data-cl-side': side,
ref: refs.setFloating,
style: floatingStyles,
'aria-labelledby': labelId,
'aria-describedby': descriptionId,
...(getFloatingProps() as React.ComponentPropsWithRef<'div'>),
};

const element = renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
props: mergeProps<'div'>(defaultProps, otherProps),
});

return (
<FloatingFocusManager
context={floatingContext}
modal={modal}
>
{element!}
</FloatingFocusManager>
);
}
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" + ' feat(headless): add Popover primitive by alexcarpenter · Pull Request #8478 · clerk/javascript · GitHub
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@@ -17,6 +17,10 @@
"import": "./dist/primitives/tooltip/index.js",
"types": "./dist/primitives/tooltip/index.d.ts"
},
"./popover": {
"import": "./dist/primitives/popover/index.js",
"types": "./dist/primitives/popover/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
111 changes: 111 additions & 0 deletions packages/headless/src/primitives/popover/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
# Popover

A floating panel anchored to a trigger element. Supports focus management, ARIA labeling, and enter/exit animations.

## When to Use

- Rich content panels, filter dropdowns, or any non-modal floating content anchored to a trigger.
- When content includes interactive elements (inputs, buttons) — unlike Tooltip which is display-only.
- Prefer Popover over Dialog when the content should be anchored to a specific element and the page should remain interactive by default.

## Usage

```tsx
import { Popover } from '@/primitives/popover';

<Popover.Root>
<Popover.Trigger>Settings</Popover.Trigger>
<Popover.Positioner>
<Popover.Popup>
<Popover.Title>Preferences</Popover.Title>
<Popover.Description>Adjust your settings below.</Popover.Description>
{/* Interactive content here */}
<Popover.Close>Done</Popover.Close>
</Popover.Popup>
</Popover.Positioner>
</Popover.Root>;
```

### Controlled

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

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

### Modal Mode

```tsx
<Popover.Root modal>{/* Focus is trapped within the popover */}</Popover.Root>
```

## Parts

| Part | Default Element | Description |
| --------------------- | --------------- | ---------------------------------------- |
| `Popover.Root` | — | Root context provider |
| `Popover.Trigger` | `<button>` | Toggles the popover on click |
| `Popover.Portal` | — | Portals children (accepts `root` prop) |
| `Popover.Positioner` | `<div>` | Floating positioned container |
| `Popover.Popup` | `<div>` | Visual content wrapper |
| `Popover.Arrow` | `<svg>` | Optional floating arrow |
| `Popover.Title` | `<h2>` | Heading, wired to `aria-labelledby` |
| `Popover.Description` | `<p>` | Description, wired to `aria-describedby` |
| `Popover.Close` | `<button>` | Closes the popover on click |

## Props

### `Popover.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"` | Floating UI placement |
| `sideOffset` | `number` | `4` | Gap between trigger and popup (px) |
| `modal` | `boolean` | `false` | Traps focus within the popover |

### `Popover.Trigger`, `Popover.Positioner`, `Popover.Popup`, `Popover.Title`, `Popover.Description`, `Popover.Close`

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

### `Popover.Arrow`

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

## Keyboard

| Key | Action |
| -------- | -------------------------------------------------------------------- |
| `Escape` | Closes the popover |
| `Tab` | Cycles focus within popover (modal mode) or moves freely (non-modal) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ---------------------------------------- |
| `data-cl-slot` | All parts | Part identifier (e.g. `"popover-popup"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Open state |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Positioning

Middleware stack: `offset` -> `flip` -> `shift` -> `arrow` -> CSS vars. The popup auto-repositions on scroll and resize via `autoUpdate`. Cross-axis flipping is enabled only when using an aligned placement (e.g. `"bottom-start"`).

## Important Notes

- **Title and Description are optional but recommended.** They wire `aria-labelledby` and `aria-describedby` to the positioner. If omitted, those attributes are simply absent.
- **Non-modal by default.** Unlike Dialog, the page remains interactive behind the popover. Set `modal={true}` for a stricter focus trap.
- **Nested popovers are supported.** The `FloatingTree` pattern handles nesting automatically.

## ARIA

- Positioner: `role="dialog"`, `aria-labelledby` (from Title), `aria-describedby` (from Description)
- Trigger: `aria-expanded`, `aria-haspopup="dialog"`, `aria-controls`
13 changes: 13 additions & 0 deletions packages/headless/src/primitives/popover/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
export * as Popover from './parts';

export type {
PopoverArrowProps,
PopoverCloseProps,
PopoverDescriptionProps,
PopoverPopupProps,
PopoverPortalProps,
PopoverPositionerProps,
PopoverProps,
PopoverTitleProps,
PopoverTriggerProps,
} from './parts';
9 changes: 9 additions & 0 deletions packages/headless/src/primitives/popover/parts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
export { type PopoverProps, PopoverRoot as Root } from './popover-root';
export { type PopoverTriggerProps, PopoverTrigger as Trigger } from './popover-trigger';
export { type PopoverPortalProps, PopoverPortal as Portal } from './popover-portal';
export { type PopoverPositionerProps, PopoverPositioner as Positioner } from './popover-positioner';
export { type PopoverPopupProps, PopoverPopup as Popup } from './popover-popup';
export { type PopoverArrowProps, PopoverArrow as Arrow } from './popover-arrow';
export { type PopoverTitleProps, PopoverTitle as Title } from './popover-title';
export { type PopoverDescriptionProps, PopoverDescription as Description } from './popover-description';
export { type PopoverCloseProps, PopoverClose as Close } from './popover-close';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverArrow(props: PopoverArrowProps) {
const { floatingContext, arrowRef, placement } = usePopoverContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='popover-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
25 changes: 25 additions & 0 deletions packages/headless/src/primitives/popover/popover-close.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
'use client';

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

export interface PopoverCloseProps extends ComponentProps<'button'> {}

export function PopoverClose(props: PopoverCloseProps) {
const { render, ...otherProps } = props;
const { setOpen } = usePopoverContext();

const defaultProps = {
type: 'button' as const,
'data-cl-slot': 'popover-close',
onClick() {
setOpen(false);
},
};

return renderElement({
defaultTagName: 'button',
render,
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
39 changes: 39 additions & 0 deletions packages/headless/src/primitives/popover/popover-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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 PopoverContextValue {
open: boolean;
setOpen: (open: boolean) => void;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
popupRef: React.RefObject<HTMLDivElement | null>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
modal: boolean;
labelId: string | undefined;
descriptionId: string | undefined;
setLabelId: React.Dispatch<React.SetStateAction<string | undefined>>;
setDescriptionId: React.Dispatch<React.SetStateAction<string | undefined>>;
mounted: boolean;
transitionProps: TransitionProps;
}

export const PopoverContext = createContext<PopoverContextValue | null>(null);

export function usePopoverContext() {
const ctx = useContext(PopoverContext);
if (!ctx) {
throw new Error('Popover compound components must be used within <Popover.Root>');
}
return ctx;
}
29 changes: 29 additions & 0 deletions packages/headless/src/primitives/popover/popover-description.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
'use client';

import { useId, useLayoutEffect } from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

export interface PopoverDescriptionProps extends ComponentProps<'p'> {}

export function PopoverDescription(props: PopoverDescriptionProps) {
const { render, ...otherProps } = props;
const { setDescriptionId } = usePopoverContext();
const id = useId();

useLayoutEffect(() => {
setDescriptionId(id);
return () => setDescriptionId(undefined);
}, [id, setDescriptionId]);

const defaultProps = {
'data-cl-slot': 'popover-description',
id,
};

return renderElement({
defaultTagName: 'p',
render,
props: mergeProps<'p'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPopup(props: PopoverPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = usePopoverContext();

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

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPortal(props: PopoverPortalProps) {
const { mounted } = usePopoverContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
42 changes: 42 additions & 0 deletions packages/headless/src/primitives/popover/popover-positioner.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
'use client';

import { FloatingFocusManager } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

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

export function PopoverPositioner(props: PopoverPositionerProps) {
const { render, ...otherProps } = props;
const { mounted, floatingContext, refs, floatingStyles, placement, getFloatingProps, modal, labelId, descriptionId } =
usePopoverContext();

const side = placement.split('-')[0];

const defaultProps = {
'data-cl-slot': 'popover-positioner',
'data-cl-side': side,
ref: refs.setFloating,
style: floatingStyles,
'aria-labelledby': labelId,
'aria-describedby': descriptionId,
...(getFloatingProps() as React.ComponentPropsWithRef<'div'>),
};

const element = renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
props: mergeProps<'div'>(defaultProps, otherProps),
});

return (
<FloatingFocusManager
context={floatingContext}
modal={modal}
>
{element!}
</FloatingFocusManager>
);
}
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('^' + ".*" + ' feat(headless): add Popover primitive by alexcarpenter · Pull Request #8478 · clerk/javascript · GitHub
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@@ -17,6 +17,10 @@
"import": "./dist/primitives/tooltip/index.js",
"types": "./dist/primitives/tooltip/index.d.ts"
},
"./popover": {
"import": "./dist/primitives/popover/index.js",
"types": "./dist/primitives/popover/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
111 changes: 111 additions & 0 deletions packages/headless/src/primitives/popover/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
# Popover

A floating panel anchored to a trigger element. Supports focus management, ARIA labeling, and enter/exit animations.

## When to Use

- Rich content panels, filter dropdowns, or any non-modal floating content anchored to a trigger.
- When content includes interactive elements (inputs, buttons) — unlike Tooltip which is display-only.
- Prefer Popover over Dialog when the content should be anchored to a specific element and the page should remain interactive by default.

## Usage

```tsx
import { Popover } from '@/primitives/popover';

<Popover.Root>
<Popover.Trigger>Settings</Popover.Trigger>
<Popover.Positioner>
<Popover.Popup>
<Popover.Title>Preferences</Popover.Title>
<Popover.Description>Adjust your settings below.</Popover.Description>
{/* Interactive content here */}
<Popover.Close>Done</Popover.Close>
</Popover.Popup>
</Popover.Positioner>
</Popover.Root>;
```

### Controlled

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

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

### Modal Mode

```tsx
<Popover.Root modal>{/* Focus is trapped within the popover */}</Popover.Root>
```

## Parts

| Part | Default Element | Description |
| --------------------- | --------------- | ---------------------------------------- |
| `Popover.Root` | — | Root context provider |
| `Popover.Trigger` | `<button>` | Toggles the popover on click |
| `Popover.Portal` | — | Portals children (accepts `root` prop) |
| `Popover.Positioner` | `<div>` | Floating positioned container |
| `Popover.Popup` | `<div>` | Visual content wrapper |
| `Popover.Arrow` | `<svg>` | Optional floating arrow |
| `Popover.Title` | `<h2>` | Heading, wired to `aria-labelledby` |
| `Popover.Description` | `<p>` | Description, wired to `aria-describedby` |
| `Popover.Close` | `<button>` | Closes the popover on click |

## Props

### `Popover.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"` | Floating UI placement |
| `sideOffset` | `number` | `4` | Gap between trigger and popup (px) |
| `modal` | `boolean` | `false` | Traps focus within the popover |

### `Popover.Trigger`, `Popover.Positioner`, `Popover.Popup`, `Popover.Title`, `Popover.Description`, `Popover.Close`

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

### `Popover.Arrow`

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

## Keyboard

| Key | Action |
| -------- | -------------------------------------------------------------------- |
| `Escape` | Closes the popover |
| `Tab` | Cycles focus within popover (modal mode) or moves freely (non-modal) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ---------------------------------------- |
| `data-cl-slot` | All parts | Part identifier (e.g. `"popover-popup"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Open state |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Positioning

Middleware stack: `offset` -> `flip` -> `shift` -> `arrow` -> CSS vars. The popup auto-repositions on scroll and resize via `autoUpdate`. Cross-axis flipping is enabled only when using an aligned placement (e.g. `"bottom-start"`).

## Important Notes

- **Title and Description are optional but recommended.** They wire `aria-labelledby` and `aria-describedby` to the positioner. If omitted, those attributes are simply absent.
- **Non-modal by default.** Unlike Dialog, the page remains interactive behind the popover. Set `modal={true}` for a stricter focus trap.
- **Nested popovers are supported.** The `FloatingTree` pattern handles nesting automatically.

## ARIA

- Positioner: `role="dialog"`, `aria-labelledby` (from Title), `aria-describedby` (from Description)
- Trigger: `aria-expanded`, `aria-haspopup="dialog"`, `aria-controls`
13 changes: 13 additions & 0 deletions packages/headless/src/primitives/popover/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
export * as Popover from './parts';

export type {
PopoverArrowProps,
PopoverCloseProps,
PopoverDescriptionProps,
PopoverPopupProps,
PopoverPortalProps,
PopoverPositionerProps,
PopoverProps,
PopoverTitleProps,
PopoverTriggerProps,
} from './parts';
9 changes: 9 additions & 0 deletions packages/headless/src/primitives/popover/parts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
export { type PopoverProps, PopoverRoot as Root } from './popover-root';
export { type PopoverTriggerProps, PopoverTrigger as Trigger } from './popover-trigger';
export { type PopoverPortalProps, PopoverPortal as Portal } from './popover-portal';
export { type PopoverPositionerProps, PopoverPositioner as Positioner } from './popover-positioner';
export { type PopoverPopupProps, PopoverPopup as Popup } from './popover-popup';
export { type PopoverArrowProps, PopoverArrow as Arrow } from './popover-arrow';
export { type PopoverTitleProps, PopoverTitle as Title } from './popover-title';
export { type PopoverDescriptionProps, PopoverDescription as Description } from './popover-description';
export { type PopoverCloseProps, PopoverClose as Close } from './popover-close';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverArrow(props: PopoverArrowProps) {
const { floatingContext, arrowRef, placement } = usePopoverContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='popover-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
25 changes: 25 additions & 0 deletions packages/headless/src/primitives/popover/popover-close.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
'use client';

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

export interface PopoverCloseProps extends ComponentProps<'button'> {}

export function PopoverClose(props: PopoverCloseProps) {
const { render, ...otherProps } = props;
const { setOpen } = usePopoverContext();

const defaultProps = {
type: 'button' as const,
'data-cl-slot': 'popover-close',
onClick() {
setOpen(false);
},
};

return renderElement({
defaultTagName: 'button',
render,
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
39 changes: 39 additions & 0 deletions packages/headless/src/primitives/popover/popover-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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 PopoverContextValue {
open: boolean;
setOpen: (open: boolean) => void;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
popupRef: React.RefObject<HTMLDivElement | null>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
modal: boolean;
labelId: string | undefined;
descriptionId: string | undefined;
setLabelId: React.Dispatch<React.SetStateAction<string | undefined>>;
setDescriptionId: React.Dispatch<React.SetStateAction<string | undefined>>;
mounted: boolean;
transitionProps: TransitionProps;
}

export const PopoverContext = createContext<PopoverContextValue | null>(null);

export function usePopoverContext() {
const ctx = useContext(PopoverContext);
if (!ctx) {
throw new Error('Popover compound components must be used within <Popover.Root>');
}
return ctx;
}
29 changes: 29 additions & 0 deletions packages/headless/src/primitives/popover/popover-description.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
'use client';

import { useId, useLayoutEffect } from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

export interface PopoverDescriptionProps extends ComponentProps<'p'> {}

export function PopoverDescription(props: PopoverDescriptionProps) {
const { render, ...otherProps } = props;
const { setDescriptionId } = usePopoverContext();
const id = useId();

useLayoutEffect(() => {
setDescriptionId(id);
return () => setDescriptionId(undefined);
}, [id, setDescriptionId]);

const defaultProps = {
'data-cl-slot': 'popover-description',
id,
};

return renderElement({
defaultTagName: 'p',
render,
props: mergeProps<'p'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPopup(props: PopoverPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = usePopoverContext();

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

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPortal(props: PopoverPortalProps) {
const { mounted } = usePopoverContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
42 changes: 42 additions & 0 deletions packages/headless/src/primitives/popover/popover-positioner.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
'use client';

import { FloatingFocusManager } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

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

export function PopoverPositioner(props: PopoverPositionerProps) {
const { render, ...otherProps } = props;
const { mounted, floatingContext, refs, floatingStyles, placement, getFloatingProps, modal, labelId, descriptionId } =
usePopoverContext();

const side = placement.split('-')[0];

const defaultProps = {
'data-cl-slot': 'popover-positioner',
'data-cl-side': side,
ref: refs.setFloating,
style: floatingStyles,
'aria-labelledby': labelId,
'aria-describedby': descriptionId,
...(getFloatingProps() as React.ComponentPropsWithRef<'div'>),
};

const element = renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
props: mergeProps<'div'>(defaultProps, otherProps),
});

return (
<FloatingFocusManager
context={floatingContext}
modal={modal}
>
{element!}
</FloatingFocusManager>
);
}
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('^' + ".*" + ' feat(headless): add Popover primitive by alexcarpenter · Pull Request #8478 · clerk/javascript · GitHub
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@@ -17,6 +17,10 @@
"import": "./dist/primitives/tooltip/index.js",
"types": "./dist/primitives/tooltip/index.d.ts"
},
"./popover": {
"import": "./dist/primitives/popover/index.js",
"types": "./dist/primitives/popover/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
111 changes: 111 additions & 0 deletions packages/headless/src/primitives/popover/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
# Popover

A floating panel anchored to a trigger element. Supports focus management, ARIA labeling, and enter/exit animations.

## When to Use

- Rich content panels, filter dropdowns, or any non-modal floating content anchored to a trigger.
- When content includes interactive elements (inputs, buttons) — unlike Tooltip which is display-only.
- Prefer Popover over Dialog when the content should be anchored to a specific element and the page should remain interactive by default.

## Usage

```tsx
import { Popover } from '@/primitives/popover';

<Popover.Root>
<Popover.Trigger>Settings</Popover.Trigger>
<Popover.Positioner>
<Popover.Popup>
<Popover.Title>Preferences</Popover.Title>
<Popover.Description>Adjust your settings below.</Popover.Description>
{/* Interactive content here */}
<Popover.Close>Done</Popover.Close>
</Popover.Popup>
</Popover.Positioner>
</Popover.Root>;
```

### Controlled

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

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

### Modal Mode

```tsx
<Popover.Root modal>{/* Focus is trapped within the popover */}</Popover.Root>
```

## Parts

| Part | Default Element | Description |
| --------------------- | --------------- | ---------------------------------------- |
| `Popover.Root` | — | Root context provider |
| `Popover.Trigger` | `<button>` | Toggles the popover on click |
| `Popover.Portal` | — | Portals children (accepts `root` prop) |
| `Popover.Positioner` | `<div>` | Floating positioned container |
| `Popover.Popup` | `<div>` | Visual content wrapper |
| `Popover.Arrow` | `<svg>` | Optional floating arrow |
| `Popover.Title` | `<h2>` | Heading, wired to `aria-labelledby` |
| `Popover.Description` | `<p>` | Description, wired to `aria-describedby` |
| `Popover.Close` | `<button>` | Closes the popover on click |

## Props

### `Popover.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"` | Floating UI placement |
| `sideOffset` | `number` | `4` | Gap between trigger and popup (px) |
| `modal` | `boolean` | `false` | Traps focus within the popover |

### `Popover.Trigger`, `Popover.Positioner`, `Popover.Popup`, `Popover.Title`, `Popover.Description`, `Popover.Close`

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

### `Popover.Arrow`

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

## Keyboard

| Key | Action |
| -------- | -------------------------------------------------------------------- |
| `Escape` | Closes the popover |
| `Tab` | Cycles focus within popover (modal mode) or moves freely (non-modal) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ---------------------------------------- |
| `data-cl-slot` | All parts | Part identifier (e.g. `"popover-popup"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Open state |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Positioning

Middleware stack: `offset` -> `flip` -> `shift` -> `arrow` -> CSS vars. The popup auto-repositions on scroll and resize via `autoUpdate`. Cross-axis flipping is enabled only when using an aligned placement (e.g. `"bottom-start"`).

## Important Notes

- **Title and Description are optional but recommended.** They wire `aria-labelledby` and `aria-describedby` to the positioner. If omitted, those attributes are simply absent.
- **Non-modal by default.** Unlike Dialog, the page remains interactive behind the popover. Set `modal={true}` for a stricter focus trap.
- **Nested popovers are supported.** The `FloatingTree` pattern handles nesting automatically.

## ARIA

- Positioner: `role="dialog"`, `aria-labelledby` (from Title), `aria-describedby` (from Description)
- Trigger: `aria-expanded`, `aria-haspopup="dialog"`, `aria-controls`
13 changes: 13 additions & 0 deletions packages/headless/src/primitives/popover/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
export * as Popover from './parts';

export type {
PopoverArrowProps,
PopoverCloseProps,
PopoverDescriptionProps,
PopoverPopupProps,
PopoverPortalProps,
PopoverPositionerProps,
PopoverProps,
PopoverTitleProps,
PopoverTriggerProps,
} from './parts';
9 changes: 9 additions & 0 deletions packages/headless/src/primitives/popover/parts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
export { type PopoverProps, PopoverRoot as Root } from './popover-root';
export { type PopoverTriggerProps, PopoverTrigger as Trigger } from './popover-trigger';
export { type PopoverPortalProps, PopoverPortal as Portal } from './popover-portal';
export { type PopoverPositionerProps, PopoverPositioner as Positioner } from './popover-positioner';
export { type PopoverPopupProps, PopoverPopup as Popup } from './popover-popup';
export { type PopoverArrowProps, PopoverArrow as Arrow } from './popover-arrow';
export { type PopoverTitleProps, PopoverTitle as Title } from './popover-title';
export { type PopoverDescriptionProps, PopoverDescription as Description } from './popover-description';
export { type PopoverCloseProps, PopoverClose as Close } from './popover-close';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverArrow(props: PopoverArrowProps) {
const { floatingContext, arrowRef, placement } = usePopoverContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='popover-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
25 changes: 25 additions & 0 deletions packages/headless/src/primitives/popover/popover-close.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
'use client';

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

export interface PopoverCloseProps extends ComponentProps<'button'> {}

export function PopoverClose(props: PopoverCloseProps) {
const { render, ...otherProps } = props;
const { setOpen } = usePopoverContext();

const defaultProps = {
type: 'button' as const,
'data-cl-slot': 'popover-close',
onClick() {
setOpen(false);
},
};

return renderElement({
defaultTagName: 'button',
render,
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
39 changes: 39 additions & 0 deletions packages/headless/src/primitives/popover/popover-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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 PopoverContextValue {
open: boolean;
setOpen: (open: boolean) => void;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
popupRef: React.RefObject<HTMLDivElement | null>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
modal: boolean;
labelId: string | undefined;
descriptionId: string | undefined;
setLabelId: React.Dispatch<React.SetStateAction<string | undefined>>;
setDescriptionId: React.Dispatch<React.SetStateAction<string | undefined>>;
mounted: boolean;
transitionProps: TransitionProps;
}

export const PopoverContext = createContext<PopoverContextValue | null>(null);

export function usePopoverContext() {
const ctx = useContext(PopoverContext);
if (!ctx) {
throw new Error('Popover compound components must be used within <Popover.Root>');
}
return ctx;
}
29 changes: 29 additions & 0 deletions packages/headless/src/primitives/popover/popover-description.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
'use client';

import { useId, useLayoutEffect } from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

export interface PopoverDescriptionProps extends ComponentProps<'p'> {}

export function PopoverDescription(props: PopoverDescriptionProps) {
const { render, ...otherProps } = props;
const { setDescriptionId } = usePopoverContext();
const id = useId();

useLayoutEffect(() => {
setDescriptionId(id);
return () => setDescriptionId(undefined);
}, [id, setDescriptionId]);

const defaultProps = {
'data-cl-slot': 'popover-description',
id,
};

return renderElement({
defaultTagName: 'p',
render,
props: mergeProps<'p'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPopup(props: PopoverPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = usePopoverContext();

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

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPortal(props: PopoverPortalProps) {
const { mounted } = usePopoverContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
42 changes: 42 additions & 0 deletions packages/headless/src/primitives/popover/popover-positioner.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
'use client';

import { FloatingFocusManager } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

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

export function PopoverPositioner(props: PopoverPositionerProps) {
const { render, ...otherProps } = props;
const { mounted, floatingContext, refs, floatingStyles, placement, getFloatingProps, modal, labelId, descriptionId } =
usePopoverContext();

const side = placement.split('-')[0];

const defaultProps = {
'data-cl-slot': 'popover-positioner',
'data-cl-side': side,
ref: refs.setFloating,
style: floatingStyles,
'aria-labelledby': labelId,
'aria-describedby': descriptionId,
...(getFloatingProps() as React.ComponentPropsWithRef<'div'>),
};

const element = renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
props: mergeProps<'div'>(defaultProps, otherProps),
});

return (
<FloatingFocusManager
context={floatingContext}
modal={modal}
>
{element!}
</FloatingFocusManager>
);
}
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); } })(); })(); feat(headless): add Popover primitive by alexcarpenter · Pull Request #8478 · clerk/javascript · GitHub
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@@ -17,6 +17,10 @@
"import": "./dist/primitives/tooltip/index.js",
"types": "./dist/primitives/tooltip/index.d.ts"
},
"./popover": {
"import": "./dist/primitives/popover/index.js",
"types": "./dist/primitives/popover/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
111 changes: 111 additions & 0 deletions packages/headless/src/primitives/popover/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
# Popover

A floating panel anchored to a trigger element. Supports focus management, ARIA labeling, and enter/exit animations.

## When to Use

- Rich content panels, filter dropdowns, or any non-modal floating content anchored to a trigger.
- When content includes interactive elements (inputs, buttons) — unlike Tooltip which is display-only.
- Prefer Popover over Dialog when the content should be anchored to a specific element and the page should remain interactive by default.

## Usage

```tsx
import { Popover } from '@/primitives/popover';

<Popover.Root>
<Popover.Trigger>Settings</Popover.Trigger>
<Popover.Positioner>
<Popover.Popup>
<Popover.Title>Preferences</Popover.Title>
<Popover.Description>Adjust your settings below.</Popover.Description>
{/* Interactive content here */}
<Popover.Close>Done</Popover.Close>
</Popover.Popup>
</Popover.Positioner>
</Popover.Root>;
```

### Controlled

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

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

### Modal Mode

```tsx
<Popover.Root modal>{/* Focus is trapped within the popover */}</Popover.Root>
```

## Parts

| Part | Default Element | Description |
| --------------------- | --------------- | ---------------------------------------- |
| `Popover.Root` | — | Root context provider |
| `Popover.Trigger` | `<button>` | Toggles the popover on click |
| `Popover.Portal` | — | Portals children (accepts `root` prop) |
| `Popover.Positioner` | `<div>` | Floating positioned container |
| `Popover.Popup` | `<div>` | Visual content wrapper |
| `Popover.Arrow` | `<svg>` | Optional floating arrow |
| `Popover.Title` | `<h2>` | Heading, wired to `aria-labelledby` |
| `Popover.Description` | `<p>` | Description, wired to `aria-describedby` |
| `Popover.Close` | `<button>` | Closes the popover on click |

## Props

### `Popover.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"` | Floating UI placement |
| `sideOffset` | `number` | `4` | Gap between trigger and popup (px) |
| `modal` | `boolean` | `false` | Traps focus within the popover |

### `Popover.Trigger`, `Popover.Positioner`, `Popover.Popup`, `Popover.Title`, `Popover.Description`, `Popover.Close`

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

### `Popover.Arrow`

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

## Keyboard

| Key | Action |
| -------- | -------------------------------------------------------------------- |
| `Escape` | Closes the popover |
| `Tab` | Cycles focus within popover (modal mode) or moves freely (non-modal) |

## Data Attributes

| Attribute | Applies To | Description |
| --------------------------------- | ----------------- | ---------------------------------------- |
| `data-cl-slot` | All parts | Part identifier (e.g. `"popover-popup"`) |
| `data-cl-open` / `data-cl-closed` | Trigger | Open state |
| `data-cl-side` | Positioner, Arrow | Resolved placement side |

## Positioning

Middleware stack: `offset` -> `flip` -> `shift` -> `arrow` -> CSS vars. The popup auto-repositions on scroll and resize via `autoUpdate`. Cross-axis flipping is enabled only when using an aligned placement (e.g. `"bottom-start"`).

## Important Notes

- **Title and Description are optional but recommended.** They wire `aria-labelledby` and `aria-describedby` to the positioner. If omitted, those attributes are simply absent.
- **Non-modal by default.** Unlike Dialog, the page remains interactive behind the popover. Set `modal={true}` for a stricter focus trap.
- **Nested popovers are supported.** The `FloatingTree` pattern handles nesting automatically.

## ARIA

- Positioner: `role="dialog"`, `aria-labelledby` (from Title), `aria-describedby` (from Description)
- Trigger: `aria-expanded`, `aria-haspopup="dialog"`, `aria-controls`
13 changes: 13 additions & 0 deletions packages/headless/src/primitives/popover/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
export * as Popover from './parts';

export type {
PopoverArrowProps,
PopoverCloseProps,
PopoverDescriptionProps,
PopoverPopupProps,
PopoverPortalProps,
PopoverPositionerProps,
PopoverProps,
PopoverTitleProps,
PopoverTriggerProps,
} from './parts';
9 changes: 9 additions & 0 deletions packages/headless/src/primitives/popover/parts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
export { type PopoverProps, PopoverRoot as Root } from './popover-root';
export { type PopoverTriggerProps, PopoverTrigger as Trigger } from './popover-trigger';
export { type PopoverPortalProps, PopoverPortal as Portal } from './popover-portal';
export { type PopoverPositionerProps, PopoverPositioner as Positioner } from './popover-positioner';
export { type PopoverPopupProps, PopoverPopup as Popup } from './popover-popup';
export { type PopoverArrowProps, PopoverArrow as Arrow } from './popover-arrow';
export { type PopoverTitleProps, PopoverTitle as Title } from './popover-title';
export { type PopoverDescriptionProps, PopoverDescription as Description } from './popover-description';
export { type PopoverCloseProps, PopoverClose as Close } from './popover-close';
22 changes: 22 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverArrow(props: PopoverArrowProps) {
const { floatingContext, arrowRef, placement } = usePopoverContext();
const side = placement.split('-')[0];

return (
<FloatingArrow
data-cl-slot='popover-arrow'
data-cl-side={side}
{...props}
ref={arrowRef}
context={floatingContext}
/>
);
}
25 changes: 25 additions & 0 deletions packages/headless/src/primitives/popover/popover-close.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
'use client';

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

export interface PopoverCloseProps extends ComponentProps<'button'> {}

export function PopoverClose(props: PopoverCloseProps) {
const { render, ...otherProps } = props;
const { setOpen } = usePopoverContext();

const defaultProps = {
type: 'button' as const,
'data-cl-slot': 'popover-close',
onClick() {
setOpen(false);
},
};

return renderElement({
defaultTagName: 'button',
render,
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
39 changes: 39 additions & 0 deletions packages/headless/src/primitives/popover/popover-context.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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 PopoverContextValue {
open: boolean;
setOpen: (open: boolean) => void;
floatingContext: FloatingContext;
refs: ExtendedRefs<ReferenceType>;
floatingStyles: CSSProperties;
placement: Placement;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
popupRef: React.RefObject<HTMLDivElement | null>;
arrowRef: React.MutableRefObject<SVGSVGElement | null>;
modal: boolean;
labelId: string | undefined;
descriptionId: string | undefined;
setLabelId: React.Dispatch<React.SetStateAction<string | undefined>>;
setDescriptionId: React.Dispatch<React.SetStateAction<string | undefined>>;
mounted: boolean;
transitionProps: TransitionProps;
}

export const PopoverContext = createContext<PopoverContextValue | null>(null);

export function usePopoverContext() {
const ctx = useContext(PopoverContext);
if (!ctx) {
throw new Error('Popover compound components must be used within <Popover.Root>');
}
return ctx;
}
29 changes: 29 additions & 0 deletions packages/headless/src/primitives/popover/popover-description.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
'use client';

import { useId, useLayoutEffect } from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

export interface PopoverDescriptionProps extends ComponentProps<'p'> {}

export function PopoverDescription(props: PopoverDescriptionProps) {
const { render, ...otherProps } = props;
const { setDescriptionId } = usePopoverContext();
const id = useId();

useLayoutEffect(() => {
setDescriptionId(id);
return () => setDescriptionId(undefined);
}, [id, setDescriptionId]);

const defaultProps = {
'data-cl-slot': 'popover-description',
id,
};

return renderElement({
defaultTagName: 'p',
render,
props: mergeProps<'p'>(defaultProps, otherProps),
});
}
23 changes: 23 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPopup(props: PopoverPopupProps) {
const { render, ...otherProps } = props;
const { popupRef, transitionProps } = usePopoverContext();

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

return renderElement({
defaultTagName: 'div',
render,
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
16 changes: 16 additions & 0 deletions packages/headless/src/primitives/popover/popover-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 { usePopoverContext } from './popover-context';

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

export function PopoverPortal(props: PopoverPortalProps) {
const { mounted } = usePopoverContext();
if (!mounted) return null;
return <FloatingPortal root={props.root}>{props.children}</FloatingPortal>;
}
42 changes: 42 additions & 0 deletions packages/headless/src/primitives/popover/popover-positioner.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
'use client';

import { FloatingFocusManager } from '@floating-ui/react';
import React from 'react';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { usePopoverContext } from './popover-context';

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

export function PopoverPositioner(props: PopoverPositionerProps) {
const { render, ...otherProps } = props;
const { mounted, floatingContext, refs, floatingStyles, placement, getFloatingProps, modal, labelId, descriptionId } =
usePopoverContext();

const side = placement.split('-')[0];

const defaultProps = {
'data-cl-slot': 'popover-positioner',
'data-cl-side': side,
ref: refs.setFloating,
style: floatingStyles,
'aria-labelledby': labelId,
'aria-describedby': descriptionId,
...(getFloatingProps() as React.ComponentPropsWithRef<'div'>),
};

const element = renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
props: mergeProps<'div'>(defaultProps, otherProps),
});

return (
<FloatingFocusManager
context={floatingContext}
modal={modal}
>
{element!}
</FloatingFocusManager>
);
}
Loading
Loading