Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UseEditableOptions

Hierarchy

  • UseEditableOptions

Index

Properties

Properties

activeCell

activeCell: CellInterface | null

Active selected cell. This can change, if the user is in formula mode

Optional getEditor

getEditor: undefined | ((cell: CellInterface | null) => React.ElementType)

Inject custom editors based on a cell

getValue

getValue: (cell: CellInterface) => any

Value getter

Type declaration

gridRef

gridRef: MutableRefObject<GridRef>

Access grid methods

Optional onBeforeEdit

onBeforeEdit: undefined | ((coords: CellInterface) => boolean)

Callback fired before editing. Can be used to prevent editing. Do not use it, Can be removed in next release.

Optional onCancel

onCancel: undefined | ((e?: React.KeyboardEvent<HTMLInputElement>) => void)

Callback when user cancels editing

onChange

onChange: (value: string, activeCell: CellInterface) => void

Callback when user changes a value in editor

Type declaration

Optional onDelete

onDelete: undefined | ((activeCell: CellInterface, selections: SelectionArea[]) => void)

Callback when user selects an area and presses delete key

Optional onSubmit

onSubmit: undefined | ((value: string, activeCell: CellInterface, nextActiveCell?: CellInterface | null) => void)

Callback when user submits a value. Use this to update state

selections

selections: SelectionArea[]

Currently selected cells, injected by useSelection

Generated using TypeDoc