Skip to main content
PROYECTOVIVIANA

Popover

The props declared for Popover, generated from the types @proyecto-viviana/ui ships.

Import

import { Popover } from "@proyecto-viviana/ui";

Props

Props for Popover in @proyecto-viviana/ui
PropTypeDefaultDescription
children*JSX.Element—The content of the popover.
idstring—DOM id for the popover element.
aria-labelstring—Accessible label for the popover.
aria-labelledbystring—Id of the element that labels the popover.
aria-describedbystring—Id of the element that describes the popover.
placement'start' | 'end' | 'top' | 'bottom' | 'left' | 'right' | 'bottom left' | 'bottom right' | 'bottom start' | 'bottom end' | 'top left' | 'top right' | 'top start' | 'top end' | 'left top' | 'left bottom' | 'right top' | 'right bottom' | 'start top' | 'start bottom' | 'end top' | 'end bottom'—The position of the popover relative to the trigger.
size'S' | 'M' | 'L'—Size variant of the popover.
classstring—Additional CSS class name.
stylesStyleString—Spectrum-defined generated classes.
UNSAFE_classNamestring—Additional CSS class name. Use only as a last resort.
UNSAFE_styleJSX.CSSProperties—Additional inline styles. Use only as a last resort.
hideArrowfalse | true—Whether to hide the arrow pointing to the trigger.
padding'default' | 'none'—Custom padding inside the popover.
slotstring | false—A slot name for the component. HTML `slot` may be `false` to omit. solidaria-components
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the object. solidaria
autoFocusfalse | truetrueWhether focus should move to the popover container on open. solidaria-components
triggerstring—The name of the component that triggered the popover. solidaria-components
defaultOpenfalse | true—Whether the popover opens by default (uncontrolled). solidaria-components
isOpenfalse | true—Whether the popover is open (controlled). solidaria-components
onOpenChange(isOpen: boolean) => void—Handler called when the popover's open state changes. solidaria-components
maxHeightnumber—The max height of the popover. solidaria-components
triggerRef() => Element | null—The ref for the element which the popover positions itself with respect to. Required when used standalone (not within a trigger component). solidaria-components
containerPaddingnumber12The placement padding that should be applied between the element and its surrounding container. solidaria-components
offsetnumber8The additional offset applied along the main axis between the element and its anchor element. solidaria-components
crossOffsetnumber0The additional offset applied along the cross axis between the element and its anchor element. solidaria-components
shouldFlipfalse | truetrueWhether the element should flip its orientation when there is insufficient room. solidaria-components
boundaryElementElement—A boundary element for placement calculations. solidaria-components
getTargetRect(target: Element) => DOMRect | null | undefinedtarget.getBoundingClientRect()Overrides the target element's bounding rectangle. Useful for positioning relative to a specific point such as the mouse cursor (e.g. context menus) or text selection. solidaria-components
arrowRef() => Element | null—A ref for the popover arrow element. solidaria-components
scrollRef() => Element | null—A ref for the scrollable popover element. solidaria-components
isNonModalfalse | true—Whether the popover is non-modal (allows interaction outside). solidaria-components
isKeyboardDismissDisabledfalse | true—Whether pressing Escape to close should be disabled. solidaria-components
shouldCloseOnInteractOutside(element: Element) => boolean—Filter for which outside interactions should close the popover. solidaria-components
onFocusWithin(e: FocusEvent) => void—Handler that is called when the popover or a descendant receives focus. solidaria-components
onBlurWithin(e: FocusEvent) => void—Handler that is called when the popover and all descendants lose focus. solidaria-components
onFocusWithinChange(isFocusWithin: boolean) => void—Handler that is called when the popover's focus-within state changes. solidaria-components
isEnteringfalse | true—Whether the popover is entering (for animations). solidaria-components
isExitingfalse | true—Whether the popover is exiting (for animations). solidaria-components
shouldSkipAnimationfalse | true—Whether the popover should appear and disappear without an entry or exit animation. Used by PreviewTrigger to skip animations when quickly swapping between overlays. solidaria-components

Declared in packages/viviana-ui/src/popover/index.tsx.

PopoverFooter props

Props for PopoverFooter in @proyecto-viviana/ui
PropTypeDefaultDescription
children*JSX.Element—Footer content, typically buttons.
classstring—Additional CSS class.

Declared in packages/viviana-ui/src/popover/index.tsx.

PopoverHeader props

Props for PopoverHeader in @proyecto-viviana/ui
PropTypeDefaultDescription
title*string—The title of the popover.
descriptionstring—Optional description text.
classstring—Additional CSS class.

Declared in packages/viviana-ui/src/popover/index.tsx.

PopoverRender props

Props for PopoverRender in @proyecto-viviana/ui
PropTypeDefaultDescription
trigger*string | null—The name of the component that triggered the popover. solidaria-components
placement*PlacementAxis | null—The placement of the popover relative to the trigger. solidaria-components
isEntering*false | true—Whether the popover is currently entering (for animations). solidaria-components
isExiting*false | true—Whether the popover is currently exiting (for animations). solidaria-components

Declared in packages/solidaria-components/src/Popover.tsx.

PopoverTrigger props

Props for PopoverTrigger in @proyecto-viviana/ui
PropTypeDefaultDescription
children*JSX.Element—The children of the popover trigger (trigger element and popover).
isOpenfalse | true—Whether the popover is open (controlled). solidaria-components
defaultOpenfalse | true—Whether the popover is open by default (uncontrolled). solidaria-components
onOpenChange(isOpen: boolean) => void—Callback when open state changes. solidaria-components

Declared in packages/viviana-ui/src/popover/index.tsx.

Props marked solidaria or solidaria-components come from the headless layer underneath and behave the same in both registers. Components that wrap a DOM element also accept that element's standard attributes, which are left out here on purpose — listing them would bury the props that are actually ours.