API REFERENCE

GridMountedComponentLookup

Fields, allowed values, and APIs that use GridMountedComponentLookup.

Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

typescript
export type GridMountedComponentLookup<TInstance, TParams, TGui> =
  | {
      readonly status: 'mounted';
      readonly key: string;
      readonly generation: number;
      readonly instance: TInstance;
      readonly params: TParams;
      readonly gui: TGui;
    }
  | {
      readonly status: 'unmounted';
      readonly key: string;
    };

APIs using this type

Contracts containing this type