You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/useUnselect.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,11 @@ title: "useUnselect"
5
5
6
6
# `useUnselect`
7
7
8
-
This hook returns a function that unselects lines in the current `<DataTable>` that match an array of ids. Pass the name of the resource to the hook as argument.
8
+
This hook returns a function that unselects lines in a `<DataTable>` that match an array of ids. Pass the name of the resource to the hook as the 1st argument.
9
+
10
+
The 2nd optional argument accepts `storeKey`. It should match with the `storeKey` used in `useListController`.
11
+
12
+
Returned function accepts boolean as the 2nd `fromAllStoreKeys` argument - if `true`, then it will unselect the records across all storeKeys used with this resource.
Copy file name to clipboardExpand all lines: docs/useUnselectAll.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,11 @@ title: "useUnselectAll"
5
5
6
6
# `useUnselectAll`
7
7
8
-
This hook returns a function that unselects all lines in the current `<DataTable>`. Pass the name of the resource as argument.
8
+
This hook returns a function that unselects all lines in a `<DataTable>`. Pass the name of the resource as the 1st argument.
9
+
10
+
The 2nd optional argument accepts `storeKey`. It should match with the `storeKey` used in `useListController`.
11
+
12
+
Returned function accepts a boolean `fromAllStoreKeys` argument - if `true`, then it will unselect all records across all storeKeys used with this resource.
Copy file name to clipboardExpand all lines: docs_headless/src/content/docs/useUnselect.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,11 @@
2
2
title: "useUnselect"
3
3
---
4
4
5
-
This hook returns a function that unselects lines in the current data table (see `<DataTableBase>`) that match an array of ids. Pass the name of the resource to the hook as argument.
5
+
This hook returns a function that unselects lines in a data table (see `<DataTableBase>`) that match an array of ids. Pass the name of the resource to the hook as the 1st argument.
6
+
7
+
The 2nd optional argument accepts `storeKey`. It should match with the `storeKey` used in `useListController`.
8
+
9
+
Returned function accepts boolean as the 2nd `fromAllStoreKeys` argument - if `true`, then it will unselect the records across all storeKeys used with this resource.
Copy file name to clipboardExpand all lines: docs_headless/src/content/docs/useUnselectAll.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,11 @@
2
2
title: "useUnselectAll"
3
3
---
4
4
5
-
This hook returns a function that unselects all lines in the current data table (see `<DataTableBase>`). Pass the name of the resource as argument.
5
+
This hook returns a function that unselects all lines in a data table (see `<DataTableBase>`). Pass the name of the resource as the 1st argument.
6
+
7
+
The 2nd optional argument accepts `storeKey`. It should match with the `storeKey` used in `useListController`.
8
+
9
+
Returned function accepts a boolean `fromAllStoreKeys` argument - if `true`, then it will unselect all records across all storeKeys used with this resource.
0 commit comments