The tree-item component represents a child item of the tree component or another tree item.

Type Parameters

Hierarchy

Hierarchy

  • Component<P, {}>
    • IgrTreeItem

Constructors

Properties

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>
props: Readonly<P> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
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}</>;
}
}

Accessors

  • get active(): boolean
  • Marks the item as the tree's active item.

    Returns boolean

  • set active(v): void
  • Parameters

    • v: boolean

    Returns void

  • get disabled(): boolean
  • Get/Set whether the tree item is disabled. Disabled items are ignored for user interactions.

    Returns boolean

  • set disabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get expanded(): boolean
  • The tree item expansion state.

    Returns boolean

  • set expanded(v): void
  • Parameters

    • v: boolean

    Returns void

  • get label(): string
  • The tree item label.

    Returns string

  • set label(v): void
  • Parameters

    • v: string

    Returns void

  • get level(): number
  • The depth of the item, relative to the root.

    Returns number

  • set level(v): void
  • Parameters

    • v: number

    Returns void

  • get loading(): boolean
  • To be used for load-on-demand scenarios in order to specify whether the item is loading data.

    Returns boolean

  • set loading(v): void
  • Parameters

    • v: boolean

    Returns void

  • get selected(): boolean
  • The tree item selection state.

    Returns boolean

  • set selected(v): void
  • Parameters

    • v: boolean

    Returns void

  • get value(): any
  • The value entry that the tree item is visualizing. Required for searching through items.

    Returns any

  • set value(v): void
  • Parameters

    • v: any

    Returns void

Methods

  • Collapses the tree item.

    Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns 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

  • Returns void

  • Returns void

  • Expands the tree item.

    Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

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

    Returns void

  • 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

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>

    Returns any

  • Returns DOMElement<{
        children: any[];
        className: P["className"];
        ref: ((ref) => void);
        style: P["style"];
    }, any>

  • Parameters

    • element: any

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Toggles tree item expansion state.

    Returns void