Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PopoverProps

Hierarchy

Index

Properties

Optional allowHTML

allowHTML: boolean

Optional animateFill

animateFill: boolean

Optional animation

animation: string | boolean

Optional appendTo

appendTo: Element | "parent" | ((ref: Element) => Element)

Optional aria

aria: { content?: null | "auto" | "describedby" | "labelledby"; expanded?: boolean | "auto" }

Type declaration

  • Optional content?: null | "auto" | "describedby" | "labelledby"
  • Optional expanded?: boolean | "auto"

Optional arrow

arrow: string | boolean | SVGElement | DocumentFragment

Optional as

as: string | Element

Optional children

children: ReactElement<any, string | JSXElementConstructor<any>>

Optional className

className: string

Optional classNames

classNames: RootClassName & Record<never, string>

Class names for the root component and the subcomponents.

Optional content

content: ReactNode

Optional delay

delay: number | [null | number, null | number]

Optional disabled

disabled: boolean

Optional duration

duration: number | [null | number, null | number]

Optional followCursor

followCursor: boolean | "horizontal" | "vertical" | "initial"

Optional getReferenceClientRect

getReferenceClientRect: null | GetReferenceClientRect

Optional hideOnClick

hideOnClick: boolean | "toggle"

Optional ignoreAttributes

ignoreAttributes: boolean

Optional inertia

inertia: boolean

Optional inlinePositioning

inlinePositioning: boolean

Optional interactive

interactive: boolean

Optional interactiveBorder

interactiveBorder: number

Optional interactiveDebounce

interactiveDebounce: number

Optional maxWidth

maxWidth: string | number

Optional moveTransition

moveTransition: string

Optional offset

offset: [number, number] | ((__namedParameters: { placement: Placement; popper: Rect; reference: Rect }) => [number, number])

Optional placement

placement: Placement

Optional plugins

plugins: Plugin<unknown>[]

Optional popperOptions

popperOptions: Partial<Options>

Optional prefixClassNames

prefixClassNames: string

Optional ref

ref: Ref<Element>

Optional reference

reference: null | Element | RefObject<Element>

Optional render

render: (attrs: { data-escaped?: string; data-placement: Placement; data-reference-hidden?: string }, content?: ReactNode, instance?: Instance<Props>) => ReactNode

Type declaration

    • (attrs: { data-escaped?: string; data-placement: Placement; data-reference-hidden?: string }, content?: ReactNode, instance?: Instance<Props>): ReactNode
    • Parameters

      • attrs: { data-escaped?: string; data-placement: Placement; data-reference-hidden?: string }
        • Optional data-escaped?: string
        • data-placement: Placement
        • Optional data-reference-hidden?: string
      • Optional content: ReactNode
      • Optional instance: Instance<Props>

      Returns ReactNode

Optional role

role: string

Optional rootProps

rootProps: HTMLAttributes<HTMLDivElement>

Optional showOnCreate

showOnCreate: boolean

Optional singleton

singleton: SingletonObject

Optional sticky

sticky: boolean | "reference" | "popper"

Optional styles

styles: Partial<RootStyles> & Partial<{}>

Customized styling that will layer on top of the default rules.

Optional theme

theme: string

Optional touch

touch: boolean | "hold" | ["hold", number]

Optional trigger

trigger: string

Optional triggerTarget

triggerTarget: null | Element | Element[]

Optional visible

visible: boolean

Optional zIndex

zIndex: number

Methods

Optional onAfterUpdate

  • onAfterUpdate(instance: Instance<Props>, partialProps: Partial<Props>): void
  • Parameters

    • instance: Instance<Props>
    • partialProps: Partial<Props>

    Returns void

Optional onBeforeUpdate

  • onBeforeUpdate(instance: Instance<Props>, partialProps: Partial<Props>): void
  • Parameters

    • instance: Instance<Props>
    • partialProps: Partial<Props>

    Returns void

Optional onClickOutside

  • onClickOutside(instance: Instance<Props>, event: Event): void
  • Parameters

    • instance: Instance<Props>
    • event: Event

    Returns void

Optional onCreate

  • onCreate(instance: Instance<Props>): void
  • Parameters

    • instance: Instance<Props>

    Returns void

Optional onDestroy

  • onDestroy(instance: Instance<Props>): void
  • Parameters

    • instance: Instance<Props>

    Returns void

Optional onHidden

  • onHidden(instance: Instance<Props>): void
  • Parameters

    • instance: Instance<Props>

    Returns void

Optional onHide

  • onHide(instance: Instance<Props>): false | void
  • Parameters

    • instance: Instance<Props>

    Returns false | void

Optional onMount

  • onMount(instance: Instance<Props>): void
  • Parameters

    • instance: Instance<Props>

    Returns void

Optional onShow

  • onShow(instance: Instance<Props>): false | void
  • Parameters

    • instance: Instance<Props>

    Returns false | void

Optional onShown

  • onShown(instance: Instance<Props>): void
  • Parameters

    • instance: Instance<Props>

    Returns void

Optional onTrigger

  • onTrigger(instance: Instance<Props>, event: Event): void
  • Parameters

    • instance: Instance<Props>
    • event: Event

    Returns void

Optional onUntrigger

  • onUntrigger(instance: Instance<Props>, event: Event): void
  • Parameters

    • instance: Instance<Props>
    • event: Event

    Returns void

Generated using TypeDoc