Skip to content

Commit 7cba97f

Browse files
chore(ListView): add parameters section (#2511)
* chore(ListView): add parameters section * chore(ListView): apply changes as per comments
1 parent 7cc78f9 commit 7cba97f

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

components/listview/overview.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,23 @@ The ListView can refresh its data manually so the component can react to changes
9191

9292
The ListView provides events related to editing and [loading data on demand]({%slug listview-manual-operations%}). [Read more about the Blazor ListView events]({%slug listview-events%}).
9393

94+
## ListView Parameters
95+
96+
The table below lists the ListView parameters. For a full list of the ListView API members (parameters, methods, and events), check the [ListView API Reference](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.Components.TelerikListView-1).
97+
98+
@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)
99+
100+
| Parameter | Type and Default Value | Description |
101+
| --- | --- | --- |
102+
| `Class` | `string` | The `class` attribute of the `<div class="k-listview">` element. Use it to apply custom styles or [override the theme]({%slug themes-override%}). |
103+
| `Data` | `IEnumerable<TItem>` | The ListView component data collection. |
104+
| `EnableLoaderContainer` | `bool` <br /> (`true`) | The ListView loading container that is shown when there are long-running operations. |
105+
| `Height` | `string` | The `height` style of the component in any [supported CSS unit]({%slug common-features/dimensions%}). The default ListView dimensions depend on the CSS theme. |
106+
| `Page` | `int` <br /> (`1`) | The current page of the ListView component. |
107+
| `Pageable` | `bool` <br /> (`false`) | Determines if the ListView allows paging. |
108+
| `PageSize` | `int` <br /> (`10`) | The number of items to display per page in the ListView. |
109+
| `Width` | `string` | The `width` style of the component in any [supported CSS unit]({%slug common-features/dimensions%}). The default ListView dimensions depend on the CSS theme. |
110+
94111
## Next Steps
95112

96113
* [Implement ListView Templates]({%slug listview-templates%})

0 commit comments

Comments
 (0)