Skip to content

[3.4] docs(filter, gantt, grid, treelist):Filtering enhancements #995

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

Merged
merged 4 commits into from
Jun 20, 2022
Merged

[3.4] docs(filter, gantt, grid, treelist):Filtering enhancements #995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f8fd814
docs(filter, gantt, grid, treelist):Filtering enhancements
ntacheva Jun 14, 2022
7e0d030
Update components/filter/fields/overview.md
ntacheva Jun 20, 2022
89dc2eb
Update components/filter/fields/overview.md
ntacheva Jun 20, 2022
c176fea
docs(filter, gantt, grid, treelist):update wording
ntacheva Jun 20, 2022
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
2 changes: 2 additions & 0 deletions _contentTemplates/common/filtering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
| Parameter | Type and Default Value | Description |
| --- | --- | --- |
| `DefaultFilterOperator` | `FilterOperator` | Sets the default filter operator in the column it is declared for. Accepts a member of the `FilterOperator` enum. The selected operator must be applicable for the specific data type. Check the supported options in the [Filter Operators]({%slug common-features-filter-operators%}) article.
| `FilterOperators` | `List<FilterListOperator>` | Specifies the available operators. Must contain only [supported filter operators]({%slug common-features-filter-operators%}) for the specific data type. If not defined, the component will use a default list of available operators based on the field type.
| `ShowFilterCellButtons` | `bool` <br/> (`true`) | controls the visibility of the filter buttons
#end

Expand All @@ -15,6 +16,7 @@
| Parameter | Type and Default Value | Description
| ----------- | ----------- | -----------|
| `DefaultFilterOperator` | `FilterOperator` | Sets the default filter operator in the column it is declared for. Accepts a member of the `FilterOperator` enum. The selected operator must be applicable for the specific data type Check the supported options in the [Filter Operators]({%slug common-features-filter-operators%}) article. The provided default filter operator will be applied for both filters in the menu.
| `FilterOperators` | `List<FilterListOperator>` | Specifies the available operators. Must contain only [supported filter operators]({%slug common-features-filter-operators%}) for the specific data type. If not defined, the component will use a default list of available operators based on the field type.
#end

#filter-debounce-delay-customization
Expand Down
9 changes: 6 additions & 3 deletions components/filter/fields/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,12 @@ You can define different Fields settings. For example, names, labels, and [filte

The following parameters enable you to customize the appearance of the Blazor Filter Fields:

@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)

| Parameter | Type | Description |
| ----------- | ----------- | ----------- |
| `Name` | `string` | Specifies the name of the field which will be used when filtering. |
| `Type` | `Type` | Specifies the type of the field for the filtering, based on which an editor will be created.|
| `DefaultFilterOperator` | `FilterOperator` | Sets the default filter operator for the Field. Accepts a member of the `FilterOperator` enum. The selected operator must be applicable for the specific data type. Check the supported options in the [Filter Operators]({%slug common-features-filter-operators%}) article.
| `Label` | `string` | Specifies the string displayed for the given field. |
| `Operators` | `IEnumerable<FilterListOperator>` | Specifies the [available filter operators]({%slug filter-operators%}#supported-fields-operators). If not defined, a default list of available operators given the field type will be used. |
| `Name` | `string` | Specifies the field to be used when filtering. |
| `Operators` | `IEnumerable<FilterListOperator>` | Specifies the [available filter operators]({%slug filter-operators%}#supported-fields-operators). If not defined, the component will use a default list of available operators based on the field type. |
| `Type` | `Type` | Specifies the field type. This will determine the filter value editor. |