Merge pull request #5974 from IgniteUI/skrastev/state-persistence-row-selection

dkamburov · web-flow · commit cf06dc175488 · 2025-04-15T09:55:24.000+03:00
Add note regarding persisting requirement for row selection.
diff --git a/en/components/grids_templates/state-persistence.md b/en/components/grids_templates/state-persistence.md
@@ -115,6 +115,9 @@ _canonicalLink: grid/state-persistence
 > The [`IgxGridState`]({environment:angularApiUrl}/classes/igxgridstatedirective.html) directive does not take care of templates. Go to [Restoring Column](state-persistence.md#restoring-columns) section to see how to restore column templates.
 }
 
+>[!NOTE]
+> The `Row Selection`  feature requires the [`primaryKey`]({environment:angularApiUrl}/classes/IgxGridComponent.html#primaryKey) property to be set, so it can be stored/restored correctly.
+
 ## Usage
 
 [`getState`]({environment:angularApiUrl}/classes/igxgridstatedirective.html#getState) - This method returns the grid state in a serialized JSON string, so developers can just take it and save it on any data storage (database, cloud, browser localStorage, etc). The method accepts first optional parameter `serialize`, which determines whether [`getState`]({environment:angularApiUrl}/classes/igxgridstatedirective.html#getState) will return an [`IGridState`]({environment:angularApiUrl}/interfaces/igridstate.html) object or a serialized JSON string.

Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,9 @@ _canonicalLink: grid/state-persistence`
`115`	`115`	> The [`IgxGridState`]({environment:angularApiUrl}/classes/igxgridstatedirective.html) directive does not take care of templates. Go to [Restoring Column](state-persistence.md#restoring-columns) section to see how to restore column templates.
`116`	`116`	`}`
`117`	`117`
	`118`	`+>[!NOTE]`
	`119`	+> The `Row Selection` feature requires the [`primaryKey`]({environment:angularApiUrl}/classes/IgxGridComponent.html#primaryKey) property to be set, so it can be stored/restored correctly.
	`120`	`+`
`118`	`121`	`## Usage`
`119`	`122`
`120`	`123`	[`getState`]({environment:angularApiUrl}/classes/igxgridstatedirective.html#getState) - This method returns the grid state in a serialized JSON string, so developers can just take it and save it on any data storage (database, cloud, browser localStorage, etc). The method accepts first optional parameter `serialize`, which determines whether [`getState`]({environment:angularApiUrl}/classes/igxgridstatedirective.html#getState) will return an [`IGridState`]({environment:angularApiUrl}/interfaces/igridstate.html) object or a serialized JSON string.