Type Parameters

Hierarchy

Hierarchy

  • Component<P, {}>
    • IgrDashboardTileCustomization

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 collectionIndex(): number
  • Returns number

  • set collectionIndex(v): void
  • Parameters

    • v: number

    Returns void

  • get isCollectionInsertionAtEnd(): boolean
  • Returns boolean

  • set isCollectionInsertionAtEnd(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isCollectionInsertionAtIndex(): boolean
  • Returns boolean

  • set isCollectionInsertionAtIndex(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isCollectionInsertionAtStart(): boolean
  • Returns boolean

  • set isCollectionInsertionAtStart(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isCollectionRemovaltIndex(): boolean
  • Returns boolean

  • set isCollectionRemovaltIndex(v): void
  • Parameters

    • v: boolean

    Returns void

  • get matchParentIndex(): number
  • Returns number

  • set matchParentIndex(v): void
  • Parameters

    • v: number

    Returns void

  • get matchType(): string
  • Returns string

  • set matchType(v): void
  • Parameters

    • v: string

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get order(): number
  • Returns number

  • set order(v): void
  • Parameters

    • v: number

    Returns void

  • get propertyName(): string
  • Returns string

  • set propertyName(v): void
  • Parameters

    • v: string

    Returns void

  • get propertyValue(): any
  • Returns any

  • set propertyValue(v): void
  • Parameters

    • v: any

    Returns void

Methods

  • 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

  • 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 any

  • 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