Interface SettingsOptions

Options to save user settings. These options control the save settings and manage settings buttons that are displayed on the toolbar. The save settings button allows the user to save the current settings to local storage. The manage settings button allows the user to manage the saved settings, and apply them to the grid.

Hierarchy

  • SettingsOptions

Properties

defaultSettingsName?: string

The name of the default settings. This is the settings that will be applied to the grid when the user first loads the grid. The default is "Default Settings". When the user saves the settings, there is a checkbox to set the settings as the default settings. If the user checks the checkbox, the settings will be saved with the name provided in this property. It is not required to provide a value for this property.

enableSaveAsYouGo?: boolean

The flag to enable the save as you go feature. This allows the user to save the settings as they change them. The default is false. Please see https://reactdatagrid.com/examples/?example=Save_As_You_Go for an example, and https://github.com/flexicious/euxdt-example/blob/main/src/app/examples/save-as-you-go.tsx for the code.

settingsStorageKey: string

The key to use to save the settings. This is required for the save settings and manage settings buttons to be displayed. Default is null. If you provide a value, the save settings and manage settings buttons will be displayed. If you have multiple grids' with enableSettigns, and they share the same settingsStorageKey, the settings will be shared between the grids. This might cause issues if the grids have different columns, or different column widths, etc.

Generated using TypeDoc