From 59b1a3e1f6bfa6a18b09dad84aa40f86de293af3 Mon Sep 17 00:00:00 2001 From: Mangala SSS Khalsa Date: Fri, 15 May 2020 19:03:37 -0700 Subject: [PATCH] Selector: add clarifying documentation about selectAll --- doc/components/mixins/Selector.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/components/mixins/Selector.md b/doc/components/mixins/Selector.md index 0a580f546..1a0e23ba9 100644 --- a/doc/components/mixins/Selector.md +++ b/doc/components/mixins/Selector.md @@ -28,6 +28,15 @@ selector column can be chosen without regard to which fields are actually presen A selector column can be used to allow selection even in a grid where `selectionMode` is set to `none`, in which case the controls in the selector column will be the only means by which a user may select or deselect rows. +## Selecting all rows + +Selecting rows is a UI action, not a data action. When rows are selected dgrid maintains a list of selected rows in the +[`selection` property](Selection.md#property-summary). [`Selection#selectAll`](Selection.md#method-summary) is +invoked, and it _only_ acts on currently rendered rows. Selection does not modify the underlying data at all. This means +that with pagination only rows in the current page will be selected, and with virtual scrolling +(`OnDemandList/OnDemandGrid`) only a subset of the rows will be selected. The grid's `selectAll` method can be extended +to implement custom behavior in response to a `selectAll` action. + ## Additional Column Definition Properties Property | Description