Skip to content

Commit 724143d

Browse files
committed
Edit
1 parent a625fd3 commit 724143d

File tree

4 files changed

+89
-88
lines changed

4 files changed

+89
-88
lines changed

content/en/docs/marketplace/platform-supported-content/modules/data-widgets/datagrid-date-filter.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ For more information on using filter widgets, see [Data Grid 2](/appstore/module
1616

1717
#### Filter Attributes
1818

19-
Provides flexibility in how the filter determines which data to filter. **Auto** mode automatically detects filterable attributes from the parent grid when placed in grid columns. **Custom** mode allows manual specification of target datasource and attributes for more complex filtering scenarios including multi-attribute support and cross-entity filtering.
19+
Provides flexibility in how the filter determines which data to filter. **Auto** mode automatically detects filterable attributes from the parent grid when placed in grid columns. **Custom** mode allows manual specification of target data source and attributes for more complex filtering scenarios including multi-attribute support and cross-entity filtering.
2020

21-
#### Datasource to Filter
21+
#### Data Source to Filter
2222

23-
Specifies the target datasource that the filter should operate on when using Custom mode. Creates a direct reference to the specified datasource object, providing access to entity metadata and enabling real-time synchronization with datasource state changes. This property is required when Filter Attributes is set to Custom.
23+
Specifies the target data source that the filter should operate on when using custom mode. Creates a direct reference to the specified data source object, providing access to entity metadata and enabling real-time synchronization with data source state changes. This property is required when **Filter Attributes** is set to **Custom**.
2424

2525
#### Attributes
2626

@@ -32,29 +32,29 @@ Sets the initial date value that appears in the filter input when the page loads
3232

3333
#### Default Start Date
3434

35-
When the default filter is set to "Between", this property defines the initial start date for the date range. This value works in conjunction with the Default End Date to establish a default date range when the widget loads.
35+
When the default filter is set to **Between**, this property defines the initial start date for the date range. This value works in conjunction with the **Default End Date** to establish a default date range when the widget loads.
3636

3737
#### Default End Date
3838

39-
When the default filter is set to "Between", this property defines the initial end date for the date range. This value works in conjunction with the Default Start Date to establish a default date range when the widget loads.
39+
When the default filter is set to **Between**, this property defines the initial end date for the date range. This value works in conjunction with the **Default Start Date** to establish a default date range when the widget loads.
4040

4141
#### Default Filter
4242

43-
Determines the initial filter operation type when the widget loads. Available options include:
43+
Determines the initial filter operation type when the widget loads. Available options include the following:
4444

45-
* **Between**: Matches records where the date falls within a specified range (requires both start and end dates)
46-
* **Greater than**: Matches records where the date is after the specified date
47-
* **Greater than or equal**: Matches records where the date is on or after the specified date
48-
* **Equal**: Matches records where the date exactly equals the specified date
49-
* **Not equal**: Matches records where the date does not equal the specified date
50-
* **Smaller than**: Matches records where the date is before the specified date
51-
* **Smaller than or equal**: Matches records where the date is on or before the specified date
52-
* **Empty**: Matches records where the date attribute has no value
53-
* **Not empty**: Matches records where the date attribute has any value
45+
* **Between**: matches records where the date falls within a specified range (requires both start and end dates)
46+
* **Greater than**: matches records where the date is after the specified date
47+
* **Greater than or equal**: matches records where the date is on or after the specified date
48+
* **Equal**: matches records where the date exactly equals the specified date
49+
* **Not equal**: matches records where the date does not equal the specified date
50+
* **Smaller than**: matches records where the date is before the specified date
51+
* **Smaller than or equal**: matches records where the date is on or before the specified date
52+
* **Empty**: matches records where the date attribute has no value
53+
* **Not empty**: matches records where the date attribute has any value
5454

5555
#### Placeholder
5656

57-
Displays hint text in the input field when no date is selected. Helps users understand the expected date format or provides guidance on date selection. Supports text templates for dynamic content and localization.
57+
Displays hint text in the input field when no date is selected. It can help users understand the expected date format, or can provide guidance on date selection. Supports text templates for dynamic content and localization.
5858

5959
#### Adjustable by User
6060

@@ -64,32 +64,32 @@ Controls whether users can change the filter operation type. When set to **Yes**
6464

6565
#### Saved Attribute
6666

67-
Specifies an entity attribute used to store the last filter value for persistence. The attribute must be of type DateTime. When configured, the filter automatically saves its current value to this attribute when changes occur. To restore previously saved values, configure the same attribute as the Default Value.
67+
Specifies an entity attribute used to store the last filter value for persistence. The attribute must be of type DateTime. When configured, the filter automatically saves its current value to this attribute when changes occur. To restore previously saved values, configure the same attribute as the **Default Value**.
6868

6969
#### Saved Start Date Attribute
7070

71-
Specifies an entity attribute used to store the start date when using "Between" filter mode. The attribute must be of type DateTime. This works in conjunction with the Saved End Date Attribute to persist date range selections across user sessions.
71+
Specifies an entity attribute used to store the start date when using the **Between** filter mode. The attribute must be of type DateTime. This works in conjunction with the **Saved End Date Attribute** to persist date range selections across user sessions.
7272

7373
#### Saved End Date Attribute
7474

75-
Specifies an entity attribute used to store the end date when using "Between" filter mode. The attribute must be of type DateTime. This works in conjunction with the Saved Start Date Attribute to persist date range selections across user sessions.
75+
Specifies an entity attribute used to store the end date when using **Between** filter mode. The attribute must be of type DateTime. This works in conjunction with the **Saved Start Date Attribute** to persist date range selections across user sessions.
7676

7777
### Events
7878

7979
#### On Change
8080

81-
Defines an action to be executed whenever the filter value or filter type changes. This event is triggered for every user interaction including date selection, changing filter operations, or clearing the filter. Can be used to trigger microflows, nanoflows, or other actions for custom business logic.
81+
Defines an action to be executed whenever the filter value or filter type changes. This event is triggered for every user interaction including date selection, changing filter operations, or clearing the filter. It can be used to trigger microflows, nanoflows, or other actions for custom business logic.
8282

8383
### Accessibility
8484

8585
#### Comparison Button Caption
8686

87-
Provides an accessible label for the filter type selection button. This label is announced by screen readers when users navigate to the dropdown that shows available filter operations (Between, Greater than, etc.). Essential for users relying on assistive technology to understand the purpose of the button.
87+
Provides an accessible label for the filter type selection button. This label is announced by screen readers when users navigate to the drop-down menu that shows available filter operations. Employing this correctly is essential for users relying on assistive technology.
8888

8989
#### Calendar Button Caption
9090

9191
Defines the accessible label for the calendar picker button that opens the date selection interface. Screen readers announce this label when users navigate to the button, helping them understand how to access the date picker functionality.
9292

9393
#### Input Caption
9494

95-
Defines the accessible label for the date input field. Screen readers announce this label when users focus on the input field. Helps users understand that date input is expected and may include format guidance or context-specific information.
95+
Defines the accessible label for the date input field. Screen readers announce this label when users focus on the input field. This property users understand that date input is expected, and may include format guidance or context-specific information.

content/en/docs/marketplace/platform-supported-content/modules/data-widgets/datagrid-dropdown-filter.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "This document describes the properties of the Dropdown Filter widg
66

77
## Introduction
88

9-
This guide lists all the properties of the Dropdown Filter widget used with the [Data Grid 2](/appstore/modules/data-grid-2/) widget. The Dropdown Filter allows users to filter enumeration values, Boolean attributes, or association attributes through a dropdown selection interface with advanced features like multi-select and search capabilities.
9+
This guide lists all the properties of the Dropdown Filter widget used with the [Data Grid 2](/appstore/modules/data-grid-2/) widget. The dropdown filter allows users to filter enumeration values, Boolean attributes, or association attributes through a dropdown selection interface with advanced features like multi-select and search capabilities.
1010

1111
For more information on using filter widgets, see [Data Grid 2](/appstore/modules/data-grid-2/#filters).
1212

@@ -18,70 +18,70 @@ For more information on using filter widgets, see [Data Grid 2](/appstore/module
1818

1919
##### Filter By
2020

21-
Determines the type of filtering the dropdown will perform:
21+
Determines the type of filtering the dropdown filter will perform:
2222

23-
* **Attribute**: Filters based on entity attributes (enumerations, booleans)
24-
* **Association**: Filters based on entity associations and references
23+
* **Attribute**: filters based on entity attributes (enumerations, Booleans)
24+
* **Association**: filters based on entity associations and references
2525

26-
##### Data source of [widget]
26+
##### Data Source of Widget
2727

2828
This setting is displaying what data sourced is currently used to configure the filter.
2929

3030
#### Attribute Type Configuration
3131

3232
##### Attribute Config
3333

34-
Provides flexibility in how the filter determines which data to filter. **Auto** mode automatically detects filterable attributes from the parent grid when placed in grid columns. **Custom** mode allows manual specification of target datasource and attributes for more complex filtering scenarios.
34+
Provides flexibility in how the filter determines which data to filter. **Auto** mode automatically detects filterable attributes from the parent grid when placed in grid columns. **Custom** mode allows manual specification of target data source and attributes for more complex filtering scenarios.
3535

3636
##### Attribute
3737

38-
Specifies the target attribute for filtering when using attribute-based filtering. Supported attribute types include:
38+
Specifies the target attribute for filtering when using attribute-based filtering. Supported attribute types include the following:
3939

40-
* **Enum**: Enumeration attributes with predefined values
41-
* **Boolean**: True/false attributes
40+
* **Enum**: enumeration attributes with predefined values
41+
* **Boolean**: true/false attributes
4242

4343
##### Automatic Options
4444

45-
When set to **Yes**, the dropdown automatically populates with all available values from the enumeration or boolean attribute. When set to **No**, custom options must be manually configured in the Options list.
45+
When set to **Yes**, the dropdown automatically populates with all available values from the enumeration or Boolean attribute. When set to **No**, custom options must be manually configured in the **Options** list.
4646

4747
##### Options
4848

49-
Allows manual specification of dropdown options when Automatic Options is disabled. Each option contains:
49+
Allows manual specification of dropdown options when Automatic Options is disabled. Each option contains the following:
5050

51-
* **Caption**: Display text shown to users
52-
* **Value**: Actual value used for filtering
51+
* **Caption**: display text shown to users
52+
* **Value**: actual value used for filtering
5353

5454
#### Association Type Configuration
5555

5656
##### Entity
5757

58-
Defines the entity that will be used for filtering over association. Supports both Reference and ReferenceSet association types. This property is required when Filter By is set to Association.
58+
Defines the entity that will be used for filtering over association. Supports both **Reference** and **ReferenceSet** association types. This property is required when **Filter By** is set to **Association**.
5959

6060
##### Selectable Objects
6161

62-
Defines the datasource that provides the list of entities available for selection. This datasource should return all possible entities that could be associated with the parent entity. The dropdown will display these entities as selectable options.
62+
Defines the data source that provides the list of entities available for selection. This data source should return all possible entities that could be associated with the parent entity. The dropdown filter will display these entities as selectable options.
6363

6464
##### Caption
6565

66-
Specifies the attribute from the selectable objects that will be displayed as the option text in the dropdown. Must be a String attribute from the entity defined in the Selectable Objects datasource.
66+
Specifies the attribute from the selectable objects that will be displayed as the option text in the dropdown filter. Must be a string attribute from the entity defined in the **Selectable Objects** data source.
6767

6868
##### Use Lazy Load
6969

70-
Controls when dropdown options are loaded. When set to **No** (recommended), options are loaded immediately providing better personalization support and value restoration. When set to **Yes**, options are loaded on-demand when the dropdown is first opened, improving initial page load performance but limiting personalization capabilities.
70+
Controls when dropdown filter options are loaded. When set to **No** (recommended), options are loaded immediately providing better personalization support and value restoration. When set to **Yes**, options are loaded on demand when the dropdown filter is first opened, improving initial page load performance but limiting personalization capabilities.
7171

7272
#### General Configuration
7373

7474
##### Default Value
7575

76-
Sets the initial value that is selected in the dropdown when the page loads. For association filtering, this should match one of the available entity values. For attribute filtering, this should match one of the enumeration or boolean values.
76+
Sets the initial value that is selected in the dropdown filter when the page loads. For association filtering, this should match one of the available entity values. For attribute filtering, this should match one of the enumeration or Boolean values.
7777

7878
##### Filterable
7979

8080
When set to **Yes**, adds a search input to the dropdown allowing users to quickly find options by typing. This is especially useful for dropdowns with many options. The search functionality works on the display captions.
8181

8282
##### Multiselect
8383

84-
Enables selection of multiple options simultaneously. When enabled, users can select multiple enumeration values, boolean states, or associated entities. The filter will match records that contain any of the selected values.
84+
Enables selection of multiple options simultaneously. When enabled, users can select multiple enumeration values, Boolean states, or associated entities. The filter will match records that contain any of the selected values.
8585

8686
##### Empty Option Caption
8787

@@ -95,21 +95,21 @@ When set to **Yes**, adds a clear button that allows users to quickly remove the
9595

9696
Controls how selected options are displayed when multiselect is enabled:
9797

98-
* **Text**: Shows selected items as comma-separated text
99-
* **Labels**: Shows selected items as individual removable labels/tags
98+
* **Text**: shows selected items as comma-separated text
99+
* **Labels**: shows selected items as individual removable labels/tags
100100

101101
##### Selection Method
102102

103103
Determines how users can select options in multiselect mode:
104104

105-
* **Checkbox**: Adds checkboxes next to each option for explicit selection
106-
* **Row Click**: Allows selection by clicking anywhere on the option row
105+
* **Checkbox**: adds checkboxes next to each option for explicit selection
106+
* **Row Click**: allows selection by clicking anywhere on the option row
107107

108108
### Configurations
109109

110110
#### Saved Attribute
111111

112-
Specifies an entity attribute used to store the last filter value for persistence. The attribute must be of type String. When configured, the filter automatically saves its current selection to this attribute when changes occur. Note that associations are not supported for saved attributes.
112+
Specifies an entity attribute used to store the last filter value for persistence. The attribute must be of type string. When configured, the filter automatically saves its current selection to this attribute when changes occur. Note that associations are not supported for saved attributes.
113113

114114
### Events
115115

@@ -121,5 +121,5 @@ Defines an action to be executed whenever the filter selection changes. This eve
121121

122122
#### Input Caption
123123

124-
Defines the accessible label for the dropdown input element. Screen readers announce this label when users focus on the dropdown. Essential for users relying on assistive technology to understand the purpose and context of the filter dropdown.
124+
Defines the accessible label for the dropdown input element. Screen readers announce this label when users focus on the dropdown. Employing this correctly is essential for users relying on assistive technology.
125125

0 commit comments

Comments
 (0)