Interface ExhibitPopperProps

Wraps the Popper with standardized behavior. A popper has 3 lifecycle states: mounted, visible, open.

  1. Animation
  2. Resizing (see popper-max-size-modifier) // TODO - fix arrow option

// TODO - replace with useFloat and remove 'passthrough' dependency on mui

interface ExhibitPopperProps {
    anchorPosition?: ExhibitPopperPosition;
    label?: string;
    offsets?: number[];
    onClose?: (() => void);
    onClosing?: (() => void);
    onMount?: ((element, instance) => void);
    onOpen?: (() => void);
    onOpening?: (() => void);
    resizeOnOverflow?: boolean;
}

Hierarchy

  • PopperProps
    • ExhibitPopperProps

Properties

anchorPosition? label? offsets? onClose? onClosing? onMount? onOpen? onOpening? resizeOnOverflow?

Properties

Optional anchorPosition

anchorPosition?: ExhibitPopperPosition

Optional label

label?: string

Optional offsets

offsets?: number[]

major minor offset

Default Value

0, 2

Optional onClose

onClose?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onClosing

onClosing?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onMount

onMount?: ((element, instance) => void)

Type declaration

    • (element, instance): void

    • Parameters

      • element: HTMLDivElement
      • instance: Instance

      Returns void

Optional onOpen

onOpen?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onOpening

onOpening?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional resizeOnOverflow

resizeOnOverflow?: boolean

If panel can resize on overflow. Otherwise will try to fit

Settings

Member Visibility

Theme

On This Page

anchorPositionlabeloffsetsonCloseonClosingonMountonOpenonOpeningresizeOnOverflow