Popover – Radix2Solid

Native Solid 2 fork. Original documentation and designs © WorkOS; historical posts retain their original context.

Displays rich content in a portal, triggered by a button.

Styling solution Source file Download runnable sandbox

import { Popover } from "@radix-solid/primitives";
import { MixerHorizontalIcon, Cross2Icon } from "@radix-solid/icons";
import styles from "./styles.module.css";
const PopoverDemo = () => <Popover.Root>
		<Popover.Trigger asChild>{target => target("button", {
      "class": styles.IconButton,
      "aria-label": "Update dimensions",
      children: <>
				<MixerHorizontalIcon />
			</>
    })}</Popover.Trigger>
		<Popover.Portal>
			<Popover.Content class={styles.Content} sideOffset={5}>
				<div style={{
        "display": "flex",
        "flex-direction": "column",
        "gap": "10px"
      }}>
					<p class={styles.Text} style={{
          "margin-bottom": "10px"
        }}>
						Dimensions
					</p>
					<fieldset class={styles.Fieldset}>
						<label class={styles.Label} for="width">
							Width
						</label>
						<input class={styles.Input} id="width" defaultValue="100%" />
					</fieldset>
					<fieldset class={styles.Fieldset}>
						<label class={styles.Label} for="maxWidth">
							Max. width
						</label>
						<input class={styles.Input} id="maxWidth" defaultValue="300px" />
					</fieldset>
					<fieldset class={styles.Fieldset}>
						<label class={styles.Label} for="height">
							Height
						</label>
						<input class={styles.Input} id="height" defaultValue="25px" />
					</fieldset>
					<fieldset class={styles.Fieldset}>
						<label class={styles.Label} for="maxHeight">
							Max. height
						</label>
						<input class={styles.Input} id="maxHeight" defaultValue="none" />
					</fieldset>
				</div>
				<Popover.Close class={styles.Close} aria-label="Close">
					<Cross2Icon />
				</Popover.Close>
				<Popover.Arrow class={styles.Arrow} />
			</Popover.Content>
		</Popover.Portal>
	</Popover.Root>;
export default PopoverDemo;

Features

Can be controlled or uncontrolled.
Customize side, alignment, offsets, collision handling.
Optionally render a pointing arrow.
Focus is fully managed and customizable.
Supports modal and non-modal modes.
Dismissing and layering behavior is highly customizable.

Anatomy

Import all parts and piece them together.

import { Popover } from "@radix-solid/primitives";
export default () => <Popover.Root>
		<Popover.Trigger />
		<Popover.Anchor />
		<Popover.Portal>
			<Popover.Content>
				<Popover.Close />
				<Popover.Arrow />
			</Popover.Content>
		</Popover.Portal>
	</Popover.Root>;

API Reference

Root

Contains all the parts of a popover.

Prop	Type	Default
`defaultOpen`	`boolean`	—
`open`	`boolean`	—
`onOpenChange`	`function`	—
`modal`	`boolean`	`false`

Trigger

The button that toggles the popover. By default, the Popover.Content will position itself against the trigger.

Prop	Type	Default
`asChild`	`boolean`	`false`

Data attribute	Values
`[data-state]`	`"open" \| "closed"`

Anchor

An optional element to position the Popover.Content against. If this part is not used, the content will position alongside the Popover.Trigger.

Prop	Type	Default
`asChild`	`boolean`	`false`

Portal

When used, portals the content part into the body.

Prop	Type	Default
`forceMount`	`boolean`	—
`container`	`HTMLElement`	`document.body`

Content

The component that pops out when the popover is open.

Prop	Type	Default
`asChild`	`boolean`	`false`
`onOpenAutoFocus`	`function`	—
`onCloseAutoFocus`	`function`	—
`onEscapeKeyDown`	`function`	—
`onPointerDownOutside`	`function`	—
`onFocusOutside`	`function`	—
`onInteractOutside`	`function`	—
`forceMount`	`boolean`	—
`side`	`enum`	`"bottom"`
`sideOffset`	`number`	`0`
`align`	`enum`	`"center"`
`alignOffset`	`number`	`0`
`avoidCollisions`	`boolean`	`true`
`collisionBoundary`	`Boundary`	`[]`
`collisionPadding`	`number \| Padding`	`0`
`arrowPadding`	`number`	`0`
`sticky`	`enum`	`"partial"`
`hideWhenDetached`	`boolean`	`false`

Data attribute	Values
`[data-state]`	`"open" \| "closed"`
`[data-side]`	`"left" \| "right" \| "bottom" \| "top"`
`[data-align]`	`"start" \| "end" \| "center"`

CSS Variable	Description
`--radix-popover-content-transform-origin`	The `transform-origin` computed from the content and arrow positions/offsets
`--radix-popover-content-available-width`	The remaining width between the trigger and the boundary edge
`--radix-popover-content-available-height`	The remaining height between the trigger and the boundary edge
`--radix-popover-trigger-width`	The width of the trigger
`--radix-popover-trigger-height`	The height of the trigger

Arrow

An optional arrow element to render alongside the popover. This can be used to help visually link the anchor with the Popover.Content. Must be rendered inside Popover.Content.

Prop	Type	Default
`asChild`	`boolean`	`false`
`width`	`number`	`10`
`height`	`number`	`5`

Close

The button that closes an open popover.

Prop	Type	Default
`asChild`	`boolean`	`false`

Examples

Constrain the content size

You may want to constrain the width of the content so that it matches the trigger width. You may also want to constrain its height to not exceed the viewport.

We expose several CSS custom properties such as --radix-popover-trigger-width and --radix-popover-content-available-height to support this. Use them to constrain the content dimensions.

// index.tsx
import { Popover } from "@radix-solid/primitives";
import "./styles.css";
export default () => <Popover.Root>
		<Popover.Trigger>…</Popover.Trigger>
		<Popover.Portal>
			<Popover.Content class="PopoverContent" sideOffset={5}>
				…
			</Popover.Content>
		</Popover.Portal>
	</Popover.Root>;

/* styles.css */
.PopoverContent {
	width: var(--radix-popover-trigger-width);
	max-height: var(--radix-popover-content-available-height);
}

We expose a CSS custom property --radix-popover-content-transform-origin. Use it to animate the content from its computed origin based on side, sideOffset, align, alignOffset and any collisions.

// index.tsx
import { Popover } from "@radix-solid/primitives";
import "./styles.css";
export default () => <Popover.Root>
		<Popover.Trigger>…</Popover.Trigger>
		<Popover.Portal>
			<Popover.Content class="PopoverContent">…</Popover.Content>
		</Popover.Portal>
	</Popover.Root>;

/* styles.css */
.PopoverContent {
	transform-origin: var(--radix-popover-content-transform-origin);
	animation: scaleIn 0.5s ease-out;
}

@keyframes scaleIn {
	from {
		opacity: 0;
		transform: scale(0);
	}
	to {
		opacity: 1;
		transform: scale(1);
	}
}

Collision-aware animations

We expose data-side and data-align attributes. Their values will change at runtime to reflect collisions. Use them to create collision and direction-aware animations.

// index.tsx
import { Popover } from "@radix-solid/primitives";
import "./styles.css";
export default () => <Popover.Root>
		<Popover.Trigger>…</Popover.Trigger>
		<Popover.Portal>
			<Popover.Content class="PopoverContent">…</Popover.Content>
		</Popover.Portal>
	</Popover.Root>;

/* styles.css */
.PopoverContent {
	animation-duration: 0.6s;
	animation-timing-function: cubic-bezier(0.16, 1, 0.3, 1);
}
.PopoverContent[data-side="top"] {
	animation-name: slideUp;
}
.PopoverContent[data-side="bottom"] {
	animation-name: slideDown;
}

@keyframes slideDown {
	from {
		opacity: 0;
		transform: translateY(-10px);
	}
	to {
		opacity: 1;
		transform: translateY(0);
	}
}

@keyframes slideUp {
	from {
		opacity: 0;
		transform: translateY(10px);
	}
	to {
		opacity: 1;
		transform: translateY(0);
	}
}

With custom anchor

You can anchor the content to another element if you do not want to use the trigger as the anchor.

// index.tsx
import { Popover } from "@radix-solid/primitives";
import "./styles.css";
export default () => <Popover.Root>
		<Popover.Anchor asChild>{target => target("div", {
      "class": "Row",
      children: <>
				Row as anchor <Popover.Trigger>Trigger</Popover.Trigger>
			</>
    })}</Popover.Anchor>

		<Popover.Portal>
			<Popover.Content>…</Popover.Content>
		</Popover.Portal>
	</Popover.Root>;

/* styles.css */
.Row {
	background-color: gainsboro;
	padding: 20px;
}

Accessibility

Adheres to the Dialog WAI-ARIA design pattern.

Keyboard Interactions

Key	Description
`Space`	Opens/closes the popover.
`Enter`	Opens/closes the popover.
`Tab`	Moves focus to the next focusable element
`Shift + Tab`	Moves focus to the previous focusable element
`Esc`	Closes the popover and moves focus to `Popover.Trigger`.

Custom APIs

Create your own API by abstracting the primitive parts into your own component.

Abstract the arrow and set default configuration

This example abstracts the Popover.Arrow part and sets a default sideOffset configuration.

Usage

import { Popover, PopoverTrigger, PopoverContent } from "./your-popover";
export default () => <Popover>
		<PopoverTrigger>Popover trigger</PopoverTrigger>
		<PopoverContent>Popover content</PopoverContent>
	</Popover>;

Implementation

import { omit, type ComponentProps } from "solid-js";
// your-popover.tsx

import { Popover as PopoverPrimitive } from "@radix-solid/primitives";
export const Popover = PopoverPrimitive.Root;
export const PopoverTrigger = PopoverPrimitive.Trigger;
export const PopoverContent = (p: Extract<ComponentProps<typeof PopoverPrimitive.Content>, {
  asChild?: false;
}>) => <PopoverPrimitive.Portal>
			<PopoverPrimitive.Content sideOffset={5} {...omit(p, "children", "class")} ref={p.ref}>
				{p.children}
				<PopoverPrimitive.Arrow />
			</PopoverPrimitive.Content>
		</PopoverPrimitive.Portal>;