Skip to content

EditableGrid Props

Kushal edited this page Nov 28, 2020 · 2 revisions

EditableGrid Props inherit from the IDetailsListProps. This means that the Editable Grid can be configured to be used a normal DetailsList too. Below are the new properties introduced the the Editable Grid wrapper.

export interface Props extends IDetailsListProps {
    items: any[]; // grid data
    columns: IColumnConfig[]; // grid columns
    enableExport?: boolean; // true => enable export, false => disable export
    exportFileName?: string; // export file name. This is applicable only if enableExport = true
    enableSave?: boolean; // enable Save option
    enableRowEdit?: boolean; // enable row level edit
    enableColumnEdit?: boolean; // enable column level edit
    enableBulkEdit?: boolean; // enable bulk edit
    enableCellEdit?: boolean; // enable cell level edit
    onGridSelectionChange?: any; // callback hook to send grid data on grid selection change
    onGridSave?:any // callback hook to send grid data to consumer on click of Save
    enableGridRowsDelete? : boolean; // enable row delete
    enableGridRowsAdd?: boolean; // enable row add
    enableTextFieldEditMode?: boolean; // enable edit mode -> mode in which the whole grid is in editable state
    onExcelExport?: any; // callback hook which sends grid data to implement custom export functionality
    height?: string;
    width? : string;
    position?: string;
    enableUnsavedEditIndicator?: boolean; // enable icon to indicate if grid has any edits which have not been submitted
}
Clone this wiki locally