Skip to content

Commit 5f56706

Browse files
CardView: Update demo descriptions (DevExpress#30108)
1 parent ebd8bc6 commit 5f56706

File tree

12 files changed

+47
-28
lines changed

12 files changed

+47
-28
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
Card templates allow you to display custom content in cards. In this demo, a [cardTemplate](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#cardTemplate) adds car images and additional content (such as badges) to regular cards.
1+
Card templates allow you to display custom content in cards. This demo uses a [cardTemplate](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#cardTemplate) to display car images, car info, and a custom button in cards.
22
<!--split-->

apps/demos/Demos/CardView/ColumnChooser/description.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
To change field visibility at runtime, set the **columnChooser**.[enabled](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columnChooser/#enabled) property to `true`. To ensure specific fields remain visible, set the **columns[]**.[allowHiding](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columns/#allowHiding) property to `false`.
2-
<!--split-->
1+
To change field visibility at runtime, set the **columnChooser**.[enabled](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columnChooser/#enabled) property to `true`. To ensure specific fields remain visible, set the **columns[]**.[allowHiding](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columns/#allowHiding) property to `false`. In this demo, **allowHiding** is disabled for the "Full Name" and "Phone" columns.
32

4-
To display the column chooser, click the toolbar button above the CardView. You can specify the column chooser's position with the **columnChooser**.[position](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columnChooser/#position) property. Changing how users display or hide columns depends on **columnChooser**.[mode](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columnChooser/#mode):
3+
Set **columnChooser**.[mode](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columnChooser/#mode) to specify how users toggle column visibility:
54

65
* *"dragAndDrop"*
76
Users drag and drop fields between the header panel and column chooser.
87

9-
* *"select"*
8+
* *"select"*
109
Users toggle check boxes for field names.
10+
<!--split-->
11+
12+
To display the column chooser, click the column chooser icon in the CardView toolbar. You can specify the column chooser's position with the **columnChooser**.[position](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columnChooser/#position) property.
1113

1214
If the column chooser contains multiple hidden columns, assign `true` to the **search**.[enabled](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columnChooser/search/#enabled) property to enable the DevExtreme field search UI.
1315

apps/demos/Demos/CardView/ColumnHeaderFilter/description.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
DevExtreme CardView includes a header filter which allows users to filter cards by field values. Click the header filter icon in the CardView's header panel to open the pop-up menu.
1+
DevExtreme CardView includes a header filter that allows users to filter cards by field values. Click the filter icon in a field's header panel to open the pop-up CardView filter.
22
<!--split-->
33

44
### Display Header Filter Icons
55

6-
Assign `true` to the **headerFilter**.[visible](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/headerFilter/#visible) property to display header filter icons for all CardView fields. To hide the icon for a specific field, set the [allowHeaderFiltering](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columns/#allowHeaderFiltering) property to `false`.
6+
Assign `true` to the **headerFilter**.[visible](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/headerFilter/#visible) property to allow users to filter CardView fields with header icons. To hide the icon for a specific column, set **columns**.[allowHeaderFiltering](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columns/#allowHeaderFiltering) to `false`.
77

88
### Enable Search UI Within Header Filters
99

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
DevExtreme CardView fields use the same display order as data fields in the component's [dataSource](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#dataSource). You can specify a different display order with the [columns[]](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columns/) array. To reorder a field at runtime, change the **columns[]**.[visibleIndex](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columns/#visibleIndex) property.
22
<!--split-->
33

4-
To allow users to reorder fields, set [allowColumnReordering](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#allowColumnReordering) to `true`. To disable reordering operations for a specific field, assign `false` to its [allowReordering](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columns/#allowReordering) property.
4+
Users can drag and drop header items to reorder columns when [allowColumnReordering](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#allowColumnReordering) is set to `true`. To disable reordering operations for a specific field, assign `false` to its [allowReordering](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columns/#allowReordering) property. In this demo, **allowReordering** is disabled for the `OrderNumber` field.

apps/demos/Demos/CardView/DataValidation/description.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@ CardView allows you to validate user input. You can apply pre-defined [validatio
33

44
In this demo, the following rules are used:
55

6-
- [required](/Documentation/ApiReference/UI_Components/dxValidator/Validation_Rules/RequiredRule/)
7-
Specifies that field values should not be empty.
8-
- [pattern](/Documentation/ApiReference/UI_Components/dxValidator/Validation_Rules/PatternRule/)
9-
Specifies a pattern that field values should match.
10-
- [email](/Documentation/ApiReference/UI_Components/dxValidator/Validation_Rules/EmailRule/)
11-
Specifies that field values match the Email pattern.
6+
- [required](/Documentation/ApiReference/UI_Components/dxValidator/Validation_Rules/RequiredRule/)
7+
Specifies that field values should not be empty. The `birthDate`, `hireDate`, `title`, `firstName`, and `lastName` fields use required rule.
8+
- [pattern](/Documentation/ApiReference/UI_Components/dxValidator/Validation_Rules/PatternRule/)
9+
Specifies a pattern that field values should match. The `mobilePhone` field uses pattern rule.
10+
- [email](/Documentation/ApiReference/UI_Components/dxValidator/Validation_Rules/EmailRule/)
11+
Specifies that field values match the Email pattern. The `email` field uses email rule.
1212
- [async](/Documentation/ApiReference/UI_Components/dxValidator/Validation_Rules/AsyncRule/)
13-
Specifies custom validation parameters that are used to validate a value on the server.
13+
Specifies custom validation parameters that are used to validate a value on the server. The `email` field uses async rule.
14+
- [custom](/Documentation/ApiReference/UI_Components/dxValidator/Validation_Rules/CustomRule/)
15+
Specifies custom validation rules. This demo implements a custom rule to prevent users from setting `hireDate` earlier than `birthDate`.
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
The [filter panel](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/filterPanel/) is a UI element that displays the combined filter. This filter is stored in the [filterValue](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#filterValue) property and includes filters that users apply in other UI elements ([header filter](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/headerFilter/), [filterBuilder](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#filterBuilder)).
2+
<!--split-->
23

34
To display the filter panel, set the **filterPanel**.[visible](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/filterPanel/#visible) property to `true`.
45

5-
A click on the combined filter calls the integrated filter builder. You can configure it in the [filterBuilder](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#filterBuilder) object. In this demo, this object is used to add the `weekends` [custom filter operation](/Documentation/ApiReference/UI_Components/dxFilterBuilder/Configuration/customOperations).
6-
<!--split-->
6+
A click on the combined filter calls the integrated filter builder. You can configure it in the [filterBuilder](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#filterBuilder) object. In this demo, this object is used to add the `beforeNoon` and `afterNoon` [custom filter operations](/Documentation/ApiReference/UI_Components/dxFilterBuilder/Configuration/customOperations).
7+
8+
The integrated filter builder displays in a DevExtreme [Popup](/Documentation/ApiReference/UI_Components/dxPopup/) component. You can configure the filter builder popup with the [filterBuilderPopup](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#filterBuilderPopup) object.

apps/demos/Demos/CardView/Overview/description.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
The DevExtreme CardView component allows you to display business data using a 'card' UI metaphor — a visually engaging alternative to traditional grid views. Use it for employee directories, contact lists, product catalogs, or task boards.
2+
3+
To get started with the CardView component, refer to the following tutorial for step-by-step instructions: [Getting Started with CardView](/Documentation/Guide/UI_Components/CardView/Getting_Started_with_CardView/).
4+
5+
For a complete overview of CardView options, refer to the [CardView API Reference](/Documentation/ApiReference/UI_Components/dxCardView/).
26
<!--split-->
37

48
CardView ships with the following built-in data management capabilities:
@@ -13,5 +17,3 @@ CardView ships with the following built-in data management capabilities:
1317
- Data selection
1418

1519
Each card within the CardView is customizable, with UI elements such as toolbars, covers, and footers that allow you to adapt layouts.
16-
17-
For a complete overview of CardView options, refer to the [CardView API Reference](/Documentation/ApiReference/UI_Components/dxCardView/).
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
CardView can display a popup edit form. The form can include any fields from the bound data source, regardless of whether the corresponding column is visible in the grid (see the `Notes` and `Address` columns).
1+
CardView allows users to edit data in a pop-up edit form. To start editing a card, click the Edit button in its header. Only one card can be edited at a time. The pop-up edit form can include any field from the component data source, regardless of whether the corresponding column is visible in the grid (see the `Notes` field).
2+
<!--split-->
23

3-
To enable this behavior in your application, set the following properties to `true`:
4-
- [editing](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/editing/).[allowUpdating](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/editing/#allowUpdating)
4+
To enable card editing in your application, set the following [editing](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/editing/) properties to `true`:
5+
- **editing**.[allowUpdating](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/editing/#allowUpdating)
56
- **editing**.[allowAdding](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/editing/#allowAdding)
67
- **editing**.[allowDeleting](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/editing/#allowDeleting)
7-
<!--split-->
88

99
CardView uses the DevExtreme [Form](/Documentation/ApiReference/UI_Components/dxForm/) and [Popup](/Documentation/ApiReference/UI_Components/dxPopup/) components to display the form and the popup. Their default configurations are defined automatically. If these configurations do not meet your requirements, you can redefine them in the **editing** object's [form](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/editing/#form) and [popup](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/editing/#popup) properties as shown in this demo.
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,11 @@
1-
CardView supports single and multiple selection modes. Set the selection [mode](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/selection/#mode) option to either *"single"* or *"multiple"* to enable this capability.
2-
<!--split-->
1+
CardView supports single and multiple selection modes. Set [selection](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/selection/).[mode](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/selection/#mode) to either *"single"* or *"multiple"* to enable this capability.
2+
<!--split-->
3+
4+
Use the following properties to configure CardView selection:
5+
6+
- [allowSelectAll](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/selection/#allowSelectAll)
7+
Allows users to simultaneously select all or current page cards (depending on **selectAllMode**).
8+
- [selectAllMode](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/selection/#selectAllMode)
9+
Specifies the mode for selecting all cards. Applies only if **selection**.**allowSelectAll** is `true`.
10+
- [showCheckBoxesMode](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/selection/#showCheckBoxesMode)
11+
Specifies when to display card selection checkboxes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
You can use the CardView component to display data from an array of objects. Use the [dataSource](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#dataSource) and [keyExpr](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#keyExpr) properties to specify the bound array and its key field.
1+
You can use the CardView component to display and edit data from an array of objects. Use the [dataSource](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#dataSource) and [keyExpr](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/#keyExpr) properties to specify the bound array and its key field.
22

33
Use the [columns](/Documentation/ApiReference/UI_Components/dxCardView/Configuration/columns/) property to specify a list of data fields you want to display within the CardView as fields. If the **columns** property is not specified, the component creates columns for all data fields available in objects from the bound array.
44
<!--split-->

0 commit comments

Comments
 (0)