Skip to content

Commit 0861fca

Browse files
Merge pull request #6777 from syncfusion-content/984382-listview
Updated the UG document for Listview Component
2 parents da4c8fc + d849ab9 commit 0861fca

22 files changed

+157
-152
lines changed

blazor/listview/accessibility.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ documentation: ug
99

1010
# Accessibility in Blazor ListView Component
1111

12-
The [Blazor ListView](https://www.syncfusion.com/blazor-components/blazor-listview) component followed the accessibility guidelines and standards, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), [WCAG 2.2](https://www.w3.org/TR/WCAG22/) standards, and [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) that are commonly used to evaluate accessibility.
12+
The [Blazor ListView](https://www.syncfusion.com/blazor-components/blazor-listview) component adheres to established accessibility guidelines and standards, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), [WCAG 2.2](https://www.w3.org/TR/WCAG22/) standards, and [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) that are commonly used to evaluate accessibility.
1313

14-
The accessibility compliance for the Blazor ListView component is outlined below.
14+
The accessibility compliance status for the Blazor ListView component is summarized below:
1515

1616
| Accessibility Criteria | Compatibility |
1717
| -- | -- |
@@ -37,18 +37,18 @@ The accessibility compliance for the Blazor ListView component is outlined below
3737

3838
<div><img src="https://cdn.syncfusion.com/content/images/landing-page/no.png" alt="No"> - The component does not meet the requirement.</div>
3939

40-
## WAI-ARIA attributes
40+
## WAI-ARIA Attributes
4141

42-
The Blazor ListView component followed the [WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/) patterns to meet the accessibility. The following ARIA attributes are used in the ListView component:
42+
The Blazor ListView component incorporates [WAI-ARIA patterns](https://www.w3.org/WAI/ARIA/apg/patterns/) to enhance its accessibility. The following ARIA attributes are used in the ListView component:
4343

4444
| Attributes | Purpose |
4545
| ------------ | ----------------------- |
4646
| aria-selected | It indicates the selected list from the whole list. |
4747
| aria-level | It defines the hierarchical structure of a list item. |
4848

49-
## Keyboard interaction
49+
## Keyboard Interaction
5050

51-
The Blazor ListView component followed the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/listbox/#keyboardinteraction) guideline, making it easy for people who use assistive technologies (AT) and those who completely rely on keyboard navigation. The following keyboard shortcuts are supported by the ListView component.
51+
The Blazor ListView component follows [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/listbox/#keyboardinteraction), ensuring ease of use for individuals who rely on assistive technologies (AT) or prioritize keyboard navigation. The following keyboard shortcuts are supported:
5252

5353
| Windows | Mac | Actions |
5454
|------------|------ | -------------|
@@ -242,13 +242,15 @@ The Blazor ListView component followed the [keyboard interaction](https://www.w3
242242
}
243243
244244
```
245+
{% previewsample "https://blazorplayground.syncfusion.com/embed/LjVyijXiUostgsYD?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
246+
![Keyboard Interaction](./images/keyboard.png)
245247

246-
## Ensuring accessibility
248+
## Ensuring Accessibility
247249

248-
The Blazor ListView component's accessibility levels are ensured through an [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) software tool during automated testing.
250+
The accessibility levels of the Blazor ListView component are verified through the [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) software tool during automated testing.
249251

250-
The accessibility compliance of the ListView component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/listview) in a new window to evaluate the accessibility of the ListView component with accessibility tools.
252+
The accessibility compliance of the ListView component is demonstrated in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/listview) in a new window to evaluate the accessibility of the ListView component with accessibility tools.
251253

252-
## See also
254+
## See Also
253255

254256
* [Accessibility in Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components](https://blazor.syncfusion.com/documentation/common/accessibility)

blazor/listview/check-list.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
layout: post
3-
title: Check list in Blazor ListView Component | Syncfusion
4-
description: Checkout and learn here all about check list in Syncfusion Blazor ListView component and much more details.
3+
title: Checkbox in Blazor ListView Component | Syncfusion
4+
description: Checkout and learn here all about Checkbox in Syncfusion Blazor ListView component and much more details.
55
platform: Blazor
66
control: Listview
77
documentation: ug
88
---
99

10-
# Check list in Blazor ListView Component
10+
# Checkbox in Blazor ListView Component
1111

12-
The [Blazor ListView](https://www.syncfusion.com/blazor-components/blazor-listview) supports checkbox in default and group-lists which is used to select multiple items. The checkbox can be enabled by the [`ShowCheckBox`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_ShowCheckBox) property.
12+
The [Blazor ListView](https://www.syncfusion.com/blazor-components/blazor-listview) component supports checkboxes in both its default and group-list configurations, allowing users to select multiple items. Checkboxes can be enabled using the [`ShowCheckBox`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_ShowCheckBox) property.
1313

1414
The Checkbox will be useful in the scenario where there is a need to select multiple options. For example, in shipping cart it is possible to select or unselect the desired items before checkout and also it will be useful in selecting multiple items that belongs to same category using the group list.
1515

@@ -45,12 +45,12 @@ private DataModel[] Data = {
4545
}
4646
}
4747
```
48-
48+
{% previewsample "https://blazorplayground.syncfusion.com/embed/LjhSCDNWAoTAnlhg?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
4949
![Blazor ListView with Checklist](./images/list/blazor-listview-with-checklist.png)
5050

5151
## Checkbox Position
5252

53-
In ListView the checkbox can be positioned into either `Left` or `Right` side of the list-item text. This can be achieved by [`CheckBoxPosition`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_CheckBoxPosition) property. By default, checkbox will be positioned to `Left` of list-item text.
53+
The position of the checkbox can be customized to appear on either the `Left` or `Right` side of the list item's text. This is controlled by the [`CheckBoxPosition`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_CheckBoxPosition) property. By default, the checkbox is positioned to the `Left` of the list item text
5454

5555
```cshtml
5656
@using Syncfusion.Blazor.Lists
@@ -82,5 +82,5 @@ private DataModel[] Data = {
8282
}
8383
}
8484
```
85-
85+
{% previewsample "https://blazorplayground.syncfusion.com/embed/BXBoCXtMqSTlwxaJ?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
8686
![Changing Checklist Position in Blazor ListView](./images/list/blazor-listview-checklist-position.png)

blazor/listview/customizing-templates.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ documentation: ug
99

1010
# Customizing Templates in Blazor ListView Component
1111

12-
The ListView component is designed to customize each list items and group title. It uses Blazor `Template engine` to render the elements.
12+
The ListView component provides extensive customization options for its individual list items and group headers through Blazor's powerful template engine.
1313

14-
To customize the Blazor ListView component header, items, and group header using templates, you can check on this video.
14+
To customize the Blazor ListView component's header, items, and group header using templates, refer to this video:
1515

1616
{% youtube
1717
"youtube:https://www.youtube.com/watch?v=SZyehayHi_4" %}
1818

1919
## Header Template
2020

21-
ListView header can be customized with the help of the [`HeaderTemplate`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_HeaderTemplate) property. To customize header template in your application, set your customized template string to `HeaderTemplate` property along with [`ShowHeader`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_ShowHeader) property as `true` to display the ListView header.
21+
The ListView's header can be fully customized using the [`HeaderTemplate`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_HeaderTemplate) property. To display a custom header, set the desired template within the `HeaderTemplate` property and ensure the [`ShowHeader`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_ShowHeader) property is set to `true`.
2222

2323
```cshtml
2424
@using Syncfusion.Blazor.Lists
@@ -60,7 +60,7 @@ ListView header can be customized with the help of the [`HeaderTemplate`](https:
6060
}
6161
}
6262
```
63-
63+
{% previewsample "https://blazorplayground.syncfusion.com/embed/hjBSCNDWKSRiFauB?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
6464
![Blazor ListView with Header Template](./images/list/blazor-listview-header-template.png)
6565

6666
## Template
@@ -231,12 +231,12 @@ The following built-in CSS classes can be used to customize the list-items.
231231
</style>
232232
233233
```
234-
234+
{% previewsample "https://blazorplayground.syncfusion.com/embed/VjLeijDMAeRvEvIj?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
235235
![Blazor ListView with Item template](./images/list/blazor-listview-item-template.png)
236236

237-
## Group template
237+
## Group Template
238238

239-
ListView group header can be customized with the help of the [`GroupTemplate`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_GroupTemplate) property. To customize the group template in the application, set the customized template string to `GroupTemplate` property.
239+
The ListView's group header can be customized using the [`GroupTemplate`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_GroupTemplate) property. To customize the group template in the application, set the customized template string to `GroupTemplate` property.
240240

241241
In the following example, ListView is grouped based on the category. The category of each list item should be mapped with [`GroupBy`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.ListViewFieldSettings-1.html#Syncfusion_Blazor_Lists_ListViewFieldSettings_1_GroupBy) field of the data. The grouped list items have also displayed count in the group list header.
242242

@@ -296,5 +296,5 @@ In the following example, ListView is grouped based on the category. The categor
296296
</style>
297297
298298
```
299-
299+
{% previewsample "https://blazorplayground.syncfusion.com/embed/rtVIiNXiUomSAAif?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
300300
![Blazor ListView with Group Template](./images/list/blazor-listview-group-template.png)

blazor/listview/data-binding.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Data Binding in Blazor ListView Component
1111

12-
ListView provides an option to load the data either from local dataSource or remote data services. This can be done through the [`DataSource`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_DataSource) property that supports the data type of array or [`DataManager`](https://blazor.syncfusion.com/documentation/data/getting-started). ListView supports different kind of data services such as OData, OData V4, and Web API, and data formats like XML, JSON, and, JSONP with the help of DataManager Adaptors.
12+
The ListView component provides capabilities to load and display data from various sources, including local data arrays (or lists) and remote data services. This is configured through the [`DataSource`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_DataSource) property, which supports either an array/list of data objects or a [`DataManager`](https://blazor.syncfusion.com/documentation/data/getting-started) instance. The ListView supports diverse data services like OData, OData V4, and Web API, and data formats (XML, JSON) when leveraging `DataManager Adaptors`.
1313

1414
| Fields | Type | Description |
1515
|------|------|-------------|
@@ -25,13 +25,13 @@ ListView provides an option to load the data either from local dataSource or rem
2525

2626
N> When complex data bind to ListView, you should map the [`ListViewFieldSettings`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.ListViewFieldSettings-1.html) properly. Otherwise, the ListView properties remains as undefined or null.
2727

28-
## Bind to local data
28+
## Bind to Local Data
2929

3030
Local data can be represented in Array of JSON data:
3131

32-
### Array of JSON data
32+
### Array of JSON Data
3333

34-
ListView can generate its list items through an array of complex data. To get it work properly, you should map the appropriate columns to the [`ListViewFieldSettings`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.ListViewFieldSettings-1.html) property.
34+
ListView can generate its list items from a array of complex data. For correct functioning, it is important to map the appropriate properties of your data model to the [`ListViewFieldSettings`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.ListViewFieldSettings-1.html).
3535

3636
```cshtml
3737
@using Syncfusion.Blazor.Lists
@@ -67,12 +67,12 @@ ListView can generate its list items through an array of complex data. To get it
6767
6868
}
6969
```
70-
70+
{% previewsample "https://blazorplayground.syncfusion.com/embed/LZhIWNNiAolSSAhg?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
7171
![Data Binding in Blazor ListView](./images/list/blazor-listview-data-binding.png)
7272

73-
## Bind to remote data
73+
## Bind to Remote Data
7474

75-
The ListView supports to retrieve the data from remote data services with the help of [`DataManager`](https://blazor.syncfusion.com/documentation/data/getting-started) component. The [`Query`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_Query) property allows to fetch data and return it to the ListView from the database.
75+
The ListView supports retrieving data from remote data services using the [`DataManager`](https://blazor.syncfusion.com/documentation/data/getting-started) component. The [`Query`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_Query) property allows for constructing specific queries to fetch and return data to the ListView from the database or API.
7676

7777
In the following sample, `first 6 products` from the **Product** table of **NorthWind** data service are displayed.
7878

@@ -99,18 +99,17 @@ In the following sample, `first 6 products` from the **Product** table of **Nort
9999
}
100100
}
101101
```
102-
103102
![Data Binding in Blazor ListView](./images/list/blazor-listview-binding-data.png)
104103

105104
## Entity Framework
106105

107-
You need to follow the steps below to consume data from the **Entity Framework** in the ListView component.
106+
This section explains how to consume data from **Entity Framework** within the ListView component.
108107

109-
To easily bind data in the Blazor ListView component using Entity Framework, you can check out this video.
108+
To easily bind data in the Blazor ListView component using Entity Framework, check out this video.
110109

111110
{% youtube "youtube:https://www.youtube.com/watch?v=iEM_W4HP9pk" %}
112111

113-
### Handle CRUD in data access layer class
112+
### Handle CRUD in Data Access Layer Class
114113

115114
Now, add methods **AddProduct** and **DeleteProduct** in the **DataAccessLayer.cs** to handle the insert and remove operations, respectively. The **CRUD** list items are bound to the **Products** parameter.
116115

@@ -170,7 +169,7 @@ namespace EFListView.Shared.DataAccess
170169

171170
### Enable CRUD in Web API
172171

173-
Now you need to create new **Post** and **Delete** methods in the Web API controller, which will perform the CRUD operations and return the appropriate result. The **SfDataManager** will make requests to these actions based on the route name.
172+
Next, need to create new **Post** and **Delete** methods in the Web API controller, which will perform the CRUD operations and return the appropriate result. The **SfDataManager** will make requests to these actions based on the route name.
174173

175174
```csharp
176175

@@ -224,9 +223,9 @@ namespace EFListView.Server.Controllers
224223

225224
```
226225

227-
### Configure the ListView to perform CRUD operations
226+
### Configure the ListView to Perform CRUD Operations
228227

229-
You can perform CRUD operations like Add and Delete using the `Add` and `Delete the selected item` buttons.
228+
The ListView component can be configured in a Blazor component to perform CRUD operations. Use `SfButton` components to trigger `Add` and `Delete` actions.
230229

231230
* `Add button` – Adds a new list item to the ListView using the ListView component's [DataSource](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_DataSource) property.
232231
* `Delete the selected item button` - Deletes a selected list item in the ListView using the ListView component's [RemoveItems](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Lists.SfListView-1.html#Syncfusion_Blazor_Lists_SfListView_1_RemoveItems_System_Collections_Generic_IEnumerable__0__) method.
@@ -308,5 +307,5 @@ You can perform CRUD operations like Add and Delete using the `Add` and `Delete
308307

309308
N> You can find the fully working sample [here](https://github.com/SyncfusionExamples/Blazor-ListView-Entity-Framework).
310309

311-
The following GIF represents the ListView with Add and Delete the list items.
310+
The following GIF represents the ListView with Add and Delete list items.
312311
![Blazor ListView with CRUD Operations](./images/blazor-listview-crud-operation.gif)

0 commit comments

Comments
 (0)