EditSettings API in React Grid API component

Configures the edit behavior of the Grid.

Properties

allowAdding

boolean

If allowAdding is set to true, new records can be added to the Grid.

Defaults to false

allowDeleting

boolean

If allowDeleting is set to true, existing record can be deleted from the Grid.

Defaults to false

allowEditOnDblClick

boolean

If allowEditOnDblClick is set to false, Grid will not allow editing of a record on double click.

Defaults to true

allowEditing

boolean

If allowEditing is set to true, values can be updated in the existing record.

Defaults to false

allowNextRowEdit

boolean

If allowNextRowEdit is set to true, editing is done to next row. By default allowNextRowEdit is set to false.

Defaults to false

dialog

IDialogUI

Defines the dialog params to edit.

Defaults to {}

footerTemplate

string | Object | Function

Defines the custom edit elements for the dialog footer template.

Defaults to null

headerTemplate

string | Object | Function

Defines the custom edit elements for the dialog header template.

Defaults to null

mode

EditMode

Defines the mode to edit. The available editing modes are:

• Normal
• Dialog
• Batch

Defaults to Normal

newRowPosition

NewRowPosition

Defines the position of adding a new row. The available position are:

• Top
• Bottom

Defaults to Top

showAddNewRow

boolean

If showAddNewRow is set to true, it indicates whether to display the add new form by default in the grid.

Defaults to false

showConfirmDialog

boolean

if showConfirmDialog is set to false, confirm dialog does not show when batch changes are saved or discarded.

Defaults to true

showDeleteConfirmDialog

boolean

If showDeleteConfirmDialog is set to true, confirm dialog will show delete action. You can also cancel delete command.

Defaults to false

template

string | Object | Function

Defines the custom edit elements for the dialog template.

Defaults to null