tui-grid/types/editor/index.d.ts

TOAST UI Grid : Powerful data grid control supported by TOAST UI

import TuiGrid from '../index';
import { RowKey, CellValue, ListItem } from '../store/data';
import { ColumnInfo } from '../store/column';
import { Dictionary } from '../options';

export type CheckboxOptions = ListItemOptions & {
  type: 'checkbox' | 'radio';
};

export type PortalEditingKeydown = (ev: KeyboardEvent) => void;

type InstantApplyCallback = (...args: any[]) => void;

export interface CellEditorProps {
  grid: TuiGrid & { usageStatistics: boolean };
  rowKey: RowKey;
  columnInfo: ColumnInfo;
  value: CellValue;
  formattedValue: string;
  width: number;
  portalEditingKeydown: PortalEditingKeydown;
  instantApplyCallback: InstantApplyCallback;
}

export interface CellEditor {
  getElement(): HTMLElement | undefined;
  getValue(): CellValue;
  moveDropdownLayer?(gridRect: GridRectForDropDownLayerPos): void;
  mounted?(): void;
  beforeDestroy?(): void;
  el?: HTMLElement;
  isMounted?: boolean;
}

export interface ListItemOptions {
  listItems: ListItem[];
  relationListItemMap?: Dictionary<ListItem[]>;
}

export interface CellEditorClass {
  new (props: CellEditorProps): CellEditor;
}

export interface GridRectForDropDownLayerPos {
  initBodyScrollTop: number;
  initBodyScrollLeft: number;
  bodyHeight: number;
  bodyWidth: number;
  bodyScrollTop: number;
  bodyScrollLeft: number;
  headerHeight: number;
  leftSideWidth: number;
}

export interface LayerPos {
  top: number;
  left: number;
}

export interface InstantlyAppliable {
  instantApplyCallback: InstantApplyCallback | null;
}