stateRestore.bookmark.update

Since: StateRestore 2.2.0

Bookmark source value location.
Please note - this property requires the StateRestore extension for DataTables.

Description

By default, as the end user uses the StateRestore UI to load states (statesList and statesTable), the page URL will automatically update (based on the stateRestore.bookmark.src parameter) to reflect the state that was loaded (this can be the id or the name of the loaded state - stateRestore.bookmark.match).

The dynamic updating of the URL is to allow the end user to create bookmarks based on the state loaded. However, it might not always be desirable for have this behaviour - for example you might wish to only provide links to predefined states. This parameter provides the ability to disable the automatic URL updates.

Type

`boolean`

This option can be one of:

true - The page URL will be updated automatically as the user selects different states from the StateRestore UI, always reflecting the most recently loaded state.
false - The page URL will not be updated.

Default

Value: true

When StartRestore's bookmarking feature is enabled, the URL will be updated as the user changes states in the UI.

Example

Don't update the URL as user loads different states:

new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: ['stateCreate', 'statesList', 'pageLength']
		}
	},
	stateRestore: {
		bookmark: {
			src: '?dtsr',
			update: false
		}
	}
});

The following options are directly related and may also be useful in your application development.

Options