Preview

Installation

npx sigma-ui@latest add popover

Usage

<script setup lang="ts">
import {
  Popover,
  PopoverContent,
  PopoverTrigger,
} from '@/components/ui/popover';
</script>

<template>
  <Popover>
    <PopoverTrigger>
      Open popover
    </PopoverTrigger>
    <PopoverContent>
      Some popover content
    </PopoverContent>
  </Popover>
</template>

• Use v-model:open on Popover to control the open state.
• side, align, and sideOffset on PopoverContent position the popover relative to the trigger.

Examples

Custom Trigger

Use as-child on PopoverTrigger to render your own button.

<script setup lang="ts">
import {
  Popover,
  PopoverContent,
  PopoverTrigger,
} from '@/components/ui/popover';
import { Button } from '@/components/ui/button';
</script>

<template>
  <Popover>
    <PopoverTrigger as-child>
      <Button variant="outline">
        Open popover
      </Button>
    </PopoverTrigger>
    <PopoverContent
      side="top"
      class="w-80"
    >
      Some popover content
    </PopoverContent>
  </Popover>
</template>

API Reference

Popover

Props

Prop	Type	Default
defaultOpen The open state of the popover when it is initially rendered. Use when you do not need to control its open state.	boolean	-
open The controlled open state of the popover.	boolean	-
modal The modality of the popover. When set to true, interaction with outside elements will be disabled and only popover content will be visible to screen readers.	boolean	false

Events

Event	Payload
update:open Event handler called when the open state of the popover changes.	[value: boolean]

Slots

Slot	Scope
default The content of the component.	-

PopoverTrigger

Props

Prop	Type	Default
asChild Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.	boolean	-
as The element or component this component should render as. Can be overwritten by asChild.	AsTag | Component	"div"

Slots

Slot	Scope
default The content of the component.	-

PopoverContent

Props

Prop	Type	Default
forceMount Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.	boolean	-
memoDependencies Reactive dependencies that should invalidate the memoized content subtree.	unknown[]	-
side The preferred side of the trigger to render against when open. Will be reversed when collisions occur and avoidCollisions is enabled.	"top" | "right" | "bottom" | "left"	"bottom"
sideOffset The distance in pixels from the trigger.	number	4
sideFlip Flip to the opposite side when colliding with boundary.	boolean	true
align The preferred alignment against the trigger. May change when collisions occur.	"center" | "start" | "end"	"center"
alignOffset An offset in pixels from the start or end alignment options.	number	0
alignFlip Flip alignment when colliding with boundary. May only occur when prioritizePosition is true.	boolean	true
avoidCollisions When true, overrides the side and align preferences to prevent collisions with boundary edges.	boolean	true
collisionBoundary The element used as the collision boundary. By default this is the viewport, though you can provide additional element(s) to be included in this check.	Element | (Element | null)[] | null	[]
collisionPadding The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { top: 20, left: 20 }.	number | Partial<Record<"top" | "right" | "bottom" | "left", number>>	0
arrowPadding The padding between the arrow and the edges of the content. If your content has border-radius, this will prevent it from overflowing the corners.	number	0
hideShiftedArrow When true, hides the arrow when it cannot be centered to the reference element.	boolean	true
sticky The sticky behavior on the align axis. partial will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless.	"partial" | "always"	"partial"
hideWhenDetached Whether to hide the content when the trigger becomes fully occluded.	boolean	false
positionStrategy The type of CSS position property to use.	"absolute" | "fixed"	-
updatePositionStrategy Strategy to update the position of the floating element on every animation frame.	"always" | "optimized"	'optimized'
disableUpdateOnLayoutShift Whether to disable the update position for the content when the layout shifted.	boolean	false
prioritizePosition Force content to be position within the viewport. Might overlap the reference element, which may not be desired.	boolean	false
reference The custom element or virtual element that will be set as the reference to position the floating element. If provided, it will replace the default anchor element.	ReferenceElement	-
dir The reading direction of the popper content when applicable. <br> If omitted, inherits globally from ConfigProvider or assumes LTR (left-to-right) reading mode.	Direction	-
asChild Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.	boolean	-
as The element or component this component should render as. Can be overwritten by asChild.	AsTag | Component	"div"
disableOutsidePointerEvents When true, hover/focus/click interactions will be disabled on elements outside the DismissableLayer. Users will need to click twice on outside elements to interact with them: once to close the DismissableLayer, and again to trigger the element.	boolean	-

Events

Event	Payload
escapeKeyDown Event handler called when the escape key is down. Can be prevented.	[event: KeyboardEvent]
pointerDownOutside Event handler called when a pointerdown event happens outside of the DismissableLayer. Can be prevented.	[event: PointerDownOutsideEvent]
focusOutside Event handler called when the focus moves outside of the DismissableLayer. Can be prevented.	[event: FocusOutsideEvent]
interactOutside Event handler called when an interaction happens outside the DismissableLayer. Specifically, when a pointerdown event happens outside or focus moves outside of it. Can be prevented.	[event: PointerDownOutsideEvent | FocusOutsideEvent]
openAutoFocus Event handler called when auto-focusing on open. Can be prevented.	[event: Event]
closeAutoFocus Event handler called when auto-focusing on close. Can be prevented.	[event: Event]

Slots

Slot	Scope
default The content of the component.	-

Accessibility

Adheres to the Dialog WAI-ARIA design pattern. Reka UI manages focus and the ARIA attributes of the trigger and the content.

Key	Description
Space	Opens or closes the popover.
Enter	Opens or 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 the trigger.