diff --git a/doc/en/components/grids/_shared/row-selection.md b/doc/en/components/grids/_shared/row-selection.md index 11c9ee7bb..ee9fd7391 100644 --- a/doc/en/components/grids/_shared/row-selection.md +++ b/doc/en/components/grids/_shared/row-selection.md @@ -72,13 +72,12 @@ Single row selection can now be easily set up, the only thing you need to do, is ``` ```ts constructor() { - const grid = document.getElementById('grid') as IgcGridComponent; + const grid = document.getElementById('grid') as {ComponentName}Component; grid.data = this.data; grid.addEventListener("rowSelectionChanging", this.handleRowSelection); } ``` - -```typescript +```ts public handleRowSelection(args: IgcRowSelectionEventArgs) { if (args.detail.added.length && args.detail.added[0] === 3) { args.detail.cancel = true; @@ -185,6 +184,12 @@ To enable cascade row selection in the `{ComponentName}` just set the `RowSelect ``` +```tsx + + +``` + In this mode a parent's selection state entirely depends on the selection state of its children. When a parent has some selected and some deselected children, its checkbox is in an indeterminate state. @@ -223,6 +228,7 @@ The code snippet below can be used to select one or multiple rows simultaneously ``` + ```razor <{ComponentSelector} Width="100%" Id="grid" @@ -235,7 +241,7 @@ The code snippet below can be used to select one or multiple rows simultaneously Select @code { - public IgbGrid grid; + public {ComponentSelector} grid; private async void Select() { object[] array = new object[] { 1,2, 5 }; @@ -243,6 +249,7 @@ The code snippet below can be used to select one or multiple rows simultaneously } } ``` + ```html @@ -260,7 +267,7 @@ constructor() { document.getElementById("select").addEventListener("click", this.onClickSelect); } public onClickSelect() { - const grid = document.getElementById("grid") as IgcGridComponent; + const grid = document.getElementById("grid") as {ComponentName}Component; grid.selectRows([1,2,5], true); } ``` @@ -306,7 +313,7 @@ If you need to deselect rows programmatically, you can use the `DeselectRows` me Deselect @code { - public IgbGrid grid; + public {ComponentSelector} grid; private async void Deselect() { object[] array = new object[] { 1, 2, 5 }; @@ -330,7 +337,7 @@ constructor() { document.getElementById("deselect").addEventListener("click", this.onClickDeselect); } public onClickDeselect() { - const grid = document.getElementById("grid") as IgcGridComponent; + const grid = document.getElementById("grid") as {ComponentName}Component; grid.deselectRows([1,2,5]); } ``` @@ -369,9 +376,15 @@ When there is some change in the row selection `RowSelectionChanging` event is e ``` + +```html +<{ComponentSelector} id="grid"> + +``` + ```ts constructor() { - const grid = document.getElementById('grid') as IgcGridComponent; + const grid = document.getElementById('grid') as {ComponentName}Component; grid.data = this.data; grid.addEventListener("rowSelectionChanging", this.handleRowSelectionChange); } @@ -380,6 +393,7 @@ public handleRowSelectionChange(args) { args.detail.cancel = true; // this will cancel the row selection } ``` + ```tsx function handleRowSelectionChange(args: IgrRowSelectionEventArgs) { @@ -425,7 +439,7 @@ If you need to see which rows are currently selected, you can get their row IDs ```typescript public getSelectedRows() { - const grid = document.getElementById('grid') as IgcGridComponent; + const grid = document.getElementById('grid') as {ComponentName}Component; const currentSelection = grid.selectedRows; // return array of row IDs } ``` @@ -442,7 +456,7 @@ public getSelectedRows() { Get selected @code { - public IgbGrid grid; + public {ComponentSelector} grid; private async void GetSelected() { var selected = this.grid.SelectedRows; @@ -470,10 +484,9 @@ Additionally, assigning row IDs to `SelectedRows` will allow you to change the g ```ts - public mySelectedRows = [1, 2, 3]; // an array of row IDs constructor() { - const grid = document.getElementById('grid') as IgcGridComponent; + const grid = document.getElementById('grid') as {ComponentName}Component; grid.data = this.data; grid.selectedRows = this.mySelectedRows; } @@ -592,6 +605,7 @@ The `rowID` property can be used to get a reference of an `{ComponentSelector}` ``` + ```ts public rowSelectorTemplate = (ctx: IgcRowSelectorTemplateContext) => { return html` @@ -684,7 +698,7 @@ auto-generate="true"> ```ts constructor() { - const grid = document.getElementById('grid') as IgcGridComponent; + const grid = document.getElementById('grid') as {ComponentName}Component; grid.data = this.data; grid.headSelectorTemplate = this.headSelectorTemplate; } @@ -744,8 +758,7 @@ This demo shows the usage of custom header and row selectors. The latter uses `R - - + ### Excel Style Row Selectors Demo @@ -756,9 +769,7 @@ This demo uses custom templates to resemble Excel-like header and row selectors. `sample="/{ComponentSample}/row-selection-template-excel", height="550", alt="{Platform} {ComponentTitle} Selection Template Excel Example"` - - - + ### Conditional Selection Demo @@ -767,7 +778,6 @@ This demo prevents some rows from being selected using the `RowSelectionChanging `sample="/{ComponentSample}/conditional-row-selectors", height="550", alt="{Platform} {ComponentTitle} Conditional Row Selectors Example"` - ## API References * `{ComponentName}` @@ -776,7 +786,7 @@ This demo prevents some rows from being selected using the `RowSelectionChanging ## Additional Resources - + * [Selection](selection.md) * [Cell selection](cell-selection.md) * [Paging](paging.md) @@ -787,7 +797,7 @@ This demo prevents some rows from being selected using the `RowSelectionChanging * [Column Pinning](column-pinning.md) * [Column Resizing](column-resizing.md) * [Virtualization and Performance](virtualization.md) - + Our community is active and always welcoming to new ideas. diff --git a/docfx/en/components/toc.json b/docfx/en/components/toc.json index cf0d77b85..0a4859fa3 100644 --- a/docfx/en/components/toc.json +++ b/docfx/en/components/toc.json @@ -783,10 +783,10 @@ "status": "" }, { - "exclude": ["Angular", "React", "WebComponents", "Blazor"], + "exclude": ["Angular"], "name": "Row Selection", "href": "grids/tree-grid/row-selection.md", - "status": "" + "status": "NEW" }, { "exclude": ["Angular"],