Docs/API Reference

API Reference

Every prop across the three components, and the signature of every trigger hook, in one place. See Concepts for how they fit together, or the individual trigger pages for full examples.

Popout

Props

PropTypeDescriptionDefault
idstringUnique key for persistence tracking—
openbooleanControls visibilityfalse
onOpenChange(open: boolean) => voidCallback when open state changes—
animation"fade" | "zoom" | "bounce"Open/close animation"zoom"
lockScrollbooleanLock body scroll while openfalse
closeOnOverlaybooleanClose on overlay clicktrue

SlideIn

Props

PropTypeDescriptionDefault
idstringUnique key for persistence tracking—
openbooleanControls visibilityfalse
onOpenChange(open: boolean) => voidCallback when open state changes—
position"left" | "right"Which edge to slide in from"left"
animation"fade" | "slide" | "bounce"Animation style"slide"

Banner

Props

PropTypeDescriptionDefault
idstringUnique key for persistence tracking—
openbooleanControls visibilityfalse
onOpenChange(open: boolean) => voidCallback when open state changes—
position"top" | "bottom" | "left" | "right"Banner placement"bottom"
animation"fade" | "slide" | "bounce"Animation style"slide"

Trigger hooks

HookSignature
useTimerTrigger({ ms?, onOpenChange? })
useScrollTrigger({ percent?, onOpenChange? })
useExitTrigger(opts?: { topZonePx?, delayMs?, once?, onOpenChange? })
useInactivityTrigger({ ms?, onOpenChange? })
usePersistence(key: string)