Skip to content

Include 'prompt' prop in markdown and snippets in column hiding topic #1636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: vnext
Choose a base branch
from
Open

Include 'prompt' prop in markdown and snippets in column hiding topic #1636

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions doc/en/components/grids/_shared/column-hiding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,11 +360,16 @@ For this purpose all we have to do is set both the `GridToolbarActions` and the
```
<!-- ComponentEnd: HierarchicalGrid -->
<!-- end: React -->

<!-- Angular -->
The `{ComponentName}` provides us with some useful properties when it comes to using the toolbar's column hiding UI.

By using the `Title` property, we will set the title that is displayed inside the dropdown button in the toolbar.
<!-- end: Angular -->
<!-- React, Blazor, WebComponents -->
The `{ComponentName}` provides us with some useful properties when it comes to using the toolbar's column hiding UI.

By using the `Title` and `Prompt` properties, we will set the title and filter prompt that are displayed inside the dropdown in the toolbar.
<!-- end: React, Blazor, WebComponents -->
<!-- ComponentStart: Grid -->
```html
<igx-grid [data]="localdata">
Expand All @@ -380,7 +385,7 @@ By using the `Title` property, we will set the title that is displayed inside th
<{ComponentSelector} Data=northwindEmployees>
<IgbGridToolbar>
<IgbGridToolbarActions>
<IgbGridToolbarHiding @ref=HidingAction Title="Column Hiding"></IgbGridToolbarHiding>
<IgbGridToolbarHiding @ref=HidingAction Title="Column Hiding" Prompt="Type here to search"></IgbGridToolbarHiding>
</IgbGridToolbarActions>
</IgbGridToolbar>
</{ComponentSelector}>
Expand All @@ -390,7 +395,7 @@ By using the `Title` property, we will set the title that is displayed inside th
<igc-grid id="grid">
<igc-grid-toolbar>
<igc-grid-toolbar-actions>
<igc-grid-toolbar-hiding id="hidingAction" title="Column Hiding"></igc-grid-toolbar-hiding>
<igc-grid-toolbar-hiding id="hidingAction" title="Column Hiding" prompt="Type here to search"></igc-grid-toolbar-hiding>
</igc-grid-toolbar-actions>
</igc-grid-toolbar>
</igc-grid>
Expand All @@ -400,7 +405,7 @@ By using the `Title` property, we will set the title that is displayed inside th
<IgrGrid>
<IgrGridToolbar>
<IgrGridToolbarActions>
<IgrGridToolbarHiding title="Column Hiding"></IgrGridToolbarHiding>
<IgrGridToolbarHiding title="Column Hiding" prompt="Type here to search"></IgrGridToolbarHiding>
</IgrGridToolbarActions>
</IgrGridToolbar>
</IgrGrid>
Expand All @@ -427,7 +432,7 @@ By using the `Title` property, we will set the title that is displayed inside th
<{ComponentSelector} Data=northwindEmployees>
<IgbGridToolbar>
<IgbGridToolbarActions>
<IgbGridToolbarHiding @ref=HidingAction Title="Column Hiding"></IgbGridToolbarHiding>
<IgbGridToolbarHiding @ref=HidingAction Title="Column Hiding" Prompt="Type here to search"></IgbGridToolbarHiding>
</IgbGridToolbarActions>
</IgbGridToolbar>
</{ComponentSelector}>
Expand All @@ -441,7 +446,7 @@ By using the `Title` property, we will set the title that is displayed inside th
<igc-tree-grid id="treeGrid">
<igc-grid-toolbar>
<igc-grid-toolbar-actions>
<igc-grid-toolbar-hiding id="hidingAction" title="Column Hiding"></igc-grid-toolbar-hiding>
<igc-grid-toolbar-hiding id="hidingAction" title="Column Hiding" prompt="Type here to search"></igc-grid-toolbar-hiding>
</igc-grid-toolbar-actions>
</igc-grid-toolbar>
</igc-tree-grid>
Expand All @@ -455,7 +460,7 @@ By using the `Title` property, we will set the title that is displayed inside th
<IgrTreeGrid>
<IgrGridToolbar>
<IgrGridToolbarActions>
<IgrGridToolbarHiding title="Column Hiding"></IgrGridToolbarHiding>
<IgrGridToolbarHiding title="Column Hiding" prompt="Type here to search"></IgrGridToolbarHiding>
</IgrGridToolbarActions>
</IgrGridToolbar>
</IgrTreeGrid>
Expand Down Expand Up @@ -483,7 +488,7 @@ By using the `Title` property, we will set the title that is displayed inside th
<{ComponentSelector} Data=SingersData>
<IgbGridToolbar>
<IgbGridToolbarActions>
<IgbGridToolbarHiding Title="Column Hiding"></IgbGridToolbarHiding>
<IgbGridToolbarHiding Title="Column Hiding" Prompt="Type here to search"></IgbGridToolbarHiding>
</IgbGridToolbarActions>
</IgbGridToolbar>
</{ComponentSelector}>
Expand All @@ -497,7 +502,7 @@ By using the `Title` property, we will set the title that is displayed inside th
<igc-hierarchical-grid id="hierarchicalGrid1">
<igc-grid-toolbar>
<igc-grid-toolbar-actions>
<igc-grid-toolbar-hiding id="hidingAction" title="Column Hiding"></igc-grid-toolbar-hiding>
<igc-grid-toolbar-hiding id="hidingAction" title="Column Hiding" prompt="Type here to search"></igc-grid-toolbar-hiding>
</igc-grid-toolbar-actions>
</igc-grid-toolbar>
</igc-hierarchical-grid>
Expand All @@ -511,7 +516,7 @@ By using the `Title` property, we will set the title that is displayed inside th
<IgrHierarchicalGrid>
<IgrGridToolbar>
<IgrGridToolbarActions>
<IgrGridToolbarHiding title="Column Hiding"></IgrGridToolbarHiding>
<IgrGridToolbarHiding title="Column Hiding" prompt="Type here to search"></IgrGridToolbarHiding>
</IgrGridToolbarActions>
</IgrGridToolbar>
</IgrHierarchicalGrid>
Expand Down