Options
All
  • Public
  • Public/Protected
  • All
Menu

A FlyoutRegion component defines a region where flyout menus can be displayed

export
class

FlyoutRegion

extends

{React.Component}

Hierarchy

Index

Constructors

constructor

Properties

context

context: any

props

props: Readonly<object> & Readonly<IFlyoutRegionProps>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<any>

Methods

forceUpdate

  • forceUpdate(callBack?: undefined | function): void
  • Parameters

    • Optional callBack: undefined | function

    Returns void

render

  • render(): Element
  • Returns Element

setState

  • setState<K>(state: function | S | object, callback?: undefined | function): void
  • Type parameters

    • K: keyof any

    Parameters

    • state: function | S | object
    • Optional callback: undefined | function

    Returns void

Static 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

Static Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a compoment is mounted. Setting state here will trigger re-rendering.

    Returns void

Static Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IFlyoutRegionProps>, prevState: Readonly<any>, prevContext: any): void
  • Called immediately after updating occurs. Not called for the initial render.

    Parameters

    Returns void

Static Optional componentWillMount

  • componentWillMount(): void
  • Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

    Returns void

Static Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IFlyoutRegionProps>, nextContext: any): void
  • Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

    Calling Component#setState generally does not trigger this method.

    Parameters

    Returns void

Static Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Static Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IFlyoutRegionProps>, nextState: Readonly<any>, nextContext: any): void
  • Called immediately before rendering when new props or state is received. Not called for the initial render.

    Note: You cannot call Component#setState here.

    Parameters

    Returns void

Static Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IFlyoutRegionProps>, nextState: Readonly<any>, 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

    Returns boolean

Generated using TypeDoc