Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Popover<SS>

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

Properties

contentInstance

contentInstance: PopoverContent

context

descendants

descendants: Popover[]

getPopoverContext

getPopoverContext: (Anonymous function) = memoize((): IPopoverContext => {return {_zentPopover: {close: this.close,open: this.open,getContentNode: this.getPopoverNode,getTriggerNode: this.getTriggerNode,registerDescendant: this.registerDescendant,unregisterDescendant: this.unregisterDescendant,},};})

id

id: string

isOutsideSelf

isOutsideSelf: (el: HTMLElement) => boolean | null

Type declaration

    • (el: HTMLElement): boolean | null
    • Parameters

      • el: HTMLElement

      Returns boolean | null

isUnmounted

isUnmounted: boolean

pendingOnBeforeHook

pendingOnBeforeHook: boolean

Readonly props

props: Readonly<IPopoverProps> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<IPopoverState>

triggerInstance

triggerInstance: PopoverTrigger<any>

triggerNode

triggerNode: HTMLElement | null

Static Content

Content: PopoverContent = PopoverContent

Static Position

Position: { Arrow: { ArrowBottomLeftPosition: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; ArrowBottomRightPosition: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; ArrowLeftBottomPosition: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; ArrowLeftTopPosition: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; ArrowRightBottomPosition: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; ArrowRightTopPosition: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; ArrowTopLeftPosition: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; ArrowTopRightPosition: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; create: createArrowPosition }; AutoBottomCenter: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; AutoBottomLeft: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; AutoBottomRight: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; AutoTopCenter: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; AutoTopLeft: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; AutoTopRight: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; BottomCenter: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; BottomLeft: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; BottomRight: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; LeftBottom: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; LeftCenter: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; LeftTop: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; RightBottom: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; RightCenter: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; RightTop: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; TopCenter: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; TopLeft: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; TopRight: (prefix: string, ...args: ArgumentTypes<PositionFunctionImpl>) => IPopoverPosition; create: createPlacement } = Position

Type declaration

Static Trigger

Trigger: { Base: PopoverTrigger; Click: PopoverClickTrigger; Focus: FocusTrigger; Hover: PopoverHoverTrigger } = Trigger

Type declaration

Static contextType

contextType: Context<IPopoverContext> = PopoverContext

Static withPopover

withPopover: <T>(Comp: React.ComponentType<T>) => React.ComponentType<Omit<T, "popover">> = withPopover

Type declaration

    • <T>(Comp: React.ComponentType<T>): React.ComponentType<Omit<T, "popover">>
    • Type parameters

      Parameters

      • Comp: React.ComponentType<T>

      Returns React.ComponentType<Omit<T, "popover">>

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IPopoverProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

adjustPosition

  • adjustPosition(): void

close

  • close(): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

  • componentDidUpdate(prevProps: any, prevState: any): void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IPopoverProps>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

getPopoverNode

  • getPopoverNode(): Element

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

getTriggerNode

  • getTriggerNode(): HTMLElement

getVisible

injectIsOutsideSelf

  • injectIsOutsideSelf(impl: any): void

isOutsideStacked

  • isOutsideStacked(node: any): boolean

isVisibilityControlled

onContentRefChange

  • onContentRefChange(contentInstance: any): void

onPositionUpdated

  • onPositionUpdated(): void

onTriggerRefChange

  • onTriggerRefChange(triggerInstance: any, nodeFilter: any): void

open

  • open(): void

registerDescendant

  • registerDescendant(popover: Popover): void

render

  • render(): Element

safeSetState

  • safeSetState(updater: any, callback?: () => void): void

setState

  • setState<K>(state: ((prevState: Readonly<IPopoverState>, props: Readonly<IPopoverProps>) => S | {}) | (S | {}), callback?: () => void): void
  • Type parameters

    Parameters

    • state: ((prevState: Readonly<IPopoverState>, props: Readonly<IPopoverProps>) => S | {}) | (S | {})
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

setVisible

Optional shouldComponentUpdate

  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

unregisterDescendant

  • unregisterDescendant(popover: Popover): void

validateChildren

  • validateChildren(): { content: any; trigger: any }

Object literals

Static defaultProps

defaultProps: object

className

className: string = ""

containerSelector

containerSelector: string = "body"

cushion

cushion: number = 0

display

display: string = "block"

onBeforeClose

onBeforeClose: noop = noop

onBeforeShow

onBeforeShow: noop = noop

onClose

onClose: noop = noop

onPositionReady

onPositionReady: noop = noop

onPositionUpdated

onPositionUpdated: noop = noop

onShow

onShow: noop = noop

prefix

prefix: string = "zent"

wrapperClassName

wrapperClassName: string = ""

Generated using TypeDoc