Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

Properties

Private contentRef

contentRef: HTMLElement = null

Private elementRef

elementRef: HTMLSpanElement = null

Private unblockScroll

unblockScroll: () => void = null

Type declaration

    • (): void
    • Returns void

Private unsubscribeFromOutsideClick

unsubscribeFromOutsideClick: () => void = null

Type declaration

    • (): void
    • Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): 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(_: any, __namedParameters: { prevActive: boolean }): void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IProps>, prevState: Readonly<IState>): SS | null
  • 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

Private onContentRef

  • onContentRef(ref: HTMLElement): void

Private onElementRef

  • onElementRef(ref: HTMLSpanElement): void

Private onEscPress

  • onEscPress(event: KeyboardEvent): void

Private onOutsideClick

  • onOutsideClick(event: Event): void

Private onToggle

  • onToggle(event: MouseEvent<HTMLSpanElement>): void

Private removeEffects

  • removeEffects(): void

render

  • render(): Element

Private renderContent

  • renderContent(toggler: ReactElement<any>, content: ReactElement<any>): Element

Private setContentPosition

  • setContentPosition(): void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): boolean
  • 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

    • nextProps: Readonly<IProps>
    • nextState: Readonly<IState>
    • nextContext: any

    Returns boolean

toggleActiveState

  • toggleActiveState(forceState?: boolean, event?: Event | SyntheticEvent): void

Private toggleEffects

  • toggleEffects(): void

Static getDerivedStateFromProps

  • getDerivedStateFromProps(__namedParameters: { active: boolean; disabled: boolean }, __namedParameters: { prevActive: boolean }): Partial<IState>
  • Parameters

    • __namedParameters: { active: boolean; disabled: boolean }
      • active: boolean
      • disabled: boolean
    • __namedParameters: { prevActive: boolean }
      • prevActive: boolean

    Returns Partial<IState>

Object literals

Static defaultProps

defaultProps: object

align

align: AlignVariant = AlignVariant.Start

blockScroll

blockScroll: boolean = true

defaultActive

defaultActive: boolean = false

disabled

disabled: boolean = false

transitionDuration

transitionDuration: number = 0

Static propTypes

propTypes: object

active

active: Requireable<boolean> = PropTypes.bool

align

align: Requireable<"start" | "center" | "end"> = PropTypes.oneOf(AlignValues)

blockScroll

blockScroll: Requireable<boolean> = PropTypes.bool

children

children: Validator<ReactElementLike[]> = PropTypes.arrayOf(PropTypes.element).isRequired

defaultActive

defaultActive: Requireable<boolean> = PropTypes.bool

disabled

disabled: Requireable<boolean> = PropTypes.bool

hideOnClick

hideOnClick: Requireable<boolean> = PropTypes.bool

onToggle

onToggle: Requireable<(...args: any[]) => any> = PropTypes.func

transitionDuration

transitionDuration: Requireable<number> = PropTypes.number

Generated using TypeDoc