Options
All
  • Public
  • Public/Protected
  • All
Menu

A React component that hosts a multi-tabbed layout

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns Layout

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
see

https://reactjs.org/docs/context.html

Readonly props

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

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<ILayoutState>

Static Optional contextType

contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}
see

https://reactjs.org/docs/context.html#classcontexttype

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<ILayoutProps>, nextState: Readonly<ILayoutState>, nextContext: any): void

addTabToActiveTabSet

  • Adds a new tab to the active tabset (if there is one)

    Parameters

    Returns void

addTabToTabSet

  • Adds a new tab to the given tabset

    Parameters

    • tabsetId: string

      the id of the tabset where the new tab will be added

    • json: IJsonTabNode

      the json for the new tab node

    Returns void

addTabWithDragAndDrop

  • addTabWithDragAndDrop(dragText: undefined | string, json: IJsonTabNode, onDrop?: (node?: Node, event?: Event) => void): void
  • Adds a new tab by dragging a labeled panel to the drop location, dragging starts immediatelly

    Parameters

    • dragText: undefined | string

      the text to show on the drag panel

    • json: IJsonTabNode

      the json for the new tab node

    • Optional onDrop: (node?: Node, event?: Event) => void

      a callback to call when the drag is complete (node and event will be undefined if the drag was cancelled)

        • (node?: Node, event?: Event): void
        • Parameters

          • Optional node: Node
          • Optional event: Event

          Returns void

    Returns void

addTabWithDragAndDropIndirect

  • addTabWithDragAndDropIndirect(dragText: undefined | string, json: IJsonTabNode, onDrop?: (node?: Node, event?: Event) => void): void
  • Adds a new tab by dragging a labeled panel to the drop location, dragging starts when you mouse down on the panel

    Parameters

    • dragText: undefined | string

      the text to show on the drag panel

    • json: IJsonTabNode

      the json for the new tab node

    • Optional onDrop: (node?: Node, event?: Event) => void

      a callback to call when the drag is complete (node and event will be undefined if the drag was cancelled)

        • (node?: Node, event?: Event): void
        • Parameters

          • Optional node: Node
          • Optional event: Event

          Returns void

    Returns 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

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

Optional componentWillUpdate

forceUpdate

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

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

    Returns void

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 any

setState

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

Generated using TypeDoc