Skip to content

Commit

Permalink
chore(ListView): add parameters section (#2511)
Browse files Browse the repository at this point in the history
* chore(ListView): add parameters section

* chore(ListView): apply changes as per comments
  • Loading branch information
xristianstefanov authored Nov 12, 2024
1 parent 7cc78f9 commit 7cba97f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions components/listview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,23 @@ The ListView can refresh its data manually so the component can react to changes

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%}).

## ListView Parameters

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).

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

| Parameter | Type and Default Value | Description |
| --- | --- | --- |
| `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%}). |
| `Data` | `IEnumerable<TItem>` | The ListView component data collection. |
| `EnableLoaderContainer` | `bool` <br /> (`true`) | The ListView loading container that is shown when there are long-running operations. |
| `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. |
| `Page` | `int` <br /> (`1`) | The current page of the ListView component. |
| `Pageable` | `bool` <br /> (`false`) | Determines if the ListView allows paging. |
| `PageSize` | `int` <br /> (`10`) | The number of items to display per page in the ListView. |
| `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. |

## Next Steps

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

0 comments on commit 7cba97f

Please sign in to comment.