A plugin that allows you to customize formatting options and editors depending on the data type.
Use the following statement to import the plugin:
import { DataTypeProvider } from '@devexpress/dx-react-grid';
none
Name | Type | Default | Description |
---|---|---|---|
for | Array<string> | The names of columns associated with the specified formatter and editor. | |
formatterComponent? | ComponentType<DataTypeProvider.ValueFormatterProps> | A component that renders the formatted value. | |
editorComponent? | ComponentType<DataTypeProvider.ValueEditorProps> | A component that renders a custom editor. | |
availableFilterOperations? | Array<FilterOperation> | The names of filter operations that are available for the associated columns. |
Describes properties passed to a component that renders the formatted value.
Field | Type | Description |
---|---|---|
column | Column | A column object. |
row? | any | A row. |
value | any | The value to be formatted. |
Describes properties passed to a component that renders the value editor.
Field | Type | Description |
---|---|---|
column | Column | A column object. |
row? | any | A row. |
value | any | Specifies the editor value. |
onValueChange | (newValue: any) => void | Handles value changes. |
disabled | boolean | true if users should not be able to edit the value; otherwise, false. |
autoFocus | boolean | true if the editor should be focused on render; otherwise, false. |
onBlur | () => void | Calls the EditingState plugin's commitChanges handler and switches the editor from edit state when it loses focus (used for Inline Cell Editing). |
onFocus | () => void | Applies an action when the editor gets focus (used for Inline Cell Editing). |
onKeyDown | (e: {key: 'Escape' | 'Enter'}) => void | Handles key press: Enter saves changes, Esc discards them and switches the editor from edit state (used for Inline Cell Editing). |
none
Name | Plugin | Type | Description |
---|---|---|---|
getAvailableFilterOperations | Getter | (columnName: string) => Array<string>? | A function that returns the names of filter operations available for a particular column. |
valueFormatter | Template | DataTypeProvider.ValueFormatterProps | A template that renders the formatted value. |
valueEditor | Template | DataTypeProvider.ValueEditorProps | A template that renders the editor. |