Skip to content

Commit de7272d

Browse files
authored
Update README.md
1 parent 85722d7 commit de7272d

File tree

1 file changed

+28
-11
lines changed

1 file changed

+28
-11
lines changed

README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11

22
# WinUI.TableView
33

4-
`WinUI.TableView` is a lightweight and fast data grid control made for WinUI apps. It is easy to use, and capable of handling large number of items with a focus on performance. It's derived from `ListView` so you will experience fluent look and feel in your project. It comes with all the essential features you need, plus extras like an Excel like column filter, options buttons (for columns and the TableView) and easy data export.
4+
**WinUI.TableView** is a lightweight and fast data grid control made for [WinUI](https://learn.microsoft.com/en-us/windows/apps/winui/winui3) apps and now supports the [Uno Platform](https://platform.uno/docs/index.html). It is easy to use, and capable of handling large numbers of items with a focus on performance. It's derived from `ListView` so you will experience fluent look and feel in your project. It comes with all the essential features you need, plus extras like an Excel like column filter, options buttons (for columns and the TableView) and easy data export.
55

66
[![ci-build](https://github.com/w-ahmad/WinUI.TableView/actions/workflows/ci-build.yml/badge.svg)](https://github.com/w-ahmad/WinUI.TableView/actions/workflows/ci-build.yml)
77
[![cd-build](https://github.com/w-ahmad/WinUI.TableView/actions/workflows/cd-build.yml/badge.svg)](https://github.com/w-ahmad/WinUI.TableView/actions/workflows/cd-build.yml)
88
[![nuget](https://img.shields.io/nuget/v/WinUI.TableView)](https://www.nuget.org/packages/WinUI.TableView/)
99
[![nuget](https://img.shields.io/nuget/dt/WinUI.TableView)](https://www.nuget.org/packages/WinUI.TableView/)
1010

11-
## Contributors
12-
[![ci-build](https://contrib.rocks/image?repo=w-ahmad/WinUI.TableView)](https://github.com/w-ahmad/WinUI.TableView/graphs/contributors)
13-
14-
##
15-
[WinUI.TableView SampleApp](https://github.com/w-ahmad/WinUI.TableView.SampleApp)
11+
### [SampleApp](https://github.com/w-ahmad/WinUI.TableView.SampleApp)
1612

1713
![WinUI TableView SampleApp](https://raw.githubusercontent.com/w-ahmad/WinUI.TableView.SampleApp/main/WinUI.TableView%20SampleApp.gif)
1814

@@ -25,9 +21,22 @@
2521
- **Sorting**: Offers built in column sorting.
2622
- **Excel-like Column Filter**: TableView allows you to filter data within columns with an excel like flyout to enhance data exploration and analysis.
2723
- **Export functionality**: Built-in export functionality to export data to CSV format. This feature can be enabled by setting the `ShowExportOptions = true`.
24+
- **Grid Lines**: Display grid lines to improve data visibility and organization.
25+
- **Localization**: Support for multiple languages to enhance usability for global audiences.
26+
- **Alternate Row Colors**: Apply alternate row coloring for better readability and aesthetics.
27+
- **Cell & Row Context Flyout**: Provides context flyouts for cells and rows to allow quick actions. *(not available on uno)*
28+
29+
## Uno Platform Support
30+
31+
`WinUI.TableView` is compatible with the Uno Platform(WASM, Desktop), enabling you to use the control across multiple platforms.
2832

2933
## Getting Started
3034

35+
### 1: Install NuGet Package
36+
Install the `WinUI.TableView` NuGet package in your Uno Platform project:
37+
```bash
38+
Install-Package WinUI.TableView
39+
3140
### 1: Install NuGet package to your project
3241

3342
You can install the `WinUI.TableView` NuGet package using the NuGet Package Manager or by running the following command in the Package Manager Console:
@@ -53,12 +62,12 @@ In your `MainWindow.xaml`, add the `WinUI.TableView` control:
5362
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
5463
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
5564
mc:Ignorable="d"
56-
xmlns:tableView="using:WinUI.TableView">
65+
xmlns:tv="using:WinUI.TableView">
5766
5867
<Grid>
59-
<tableView:TableView x:Name="MyTableView"
60-
ItemsSource="{x:Bind ViewModel.Items}"
61-
AutoGenerateColumns="True" />
68+
<tv:TableView x:Name="MyTableView"
69+
ItemsSource="{x:Bind ViewModel.Items}"
70+
AutoGenerateColumns="True" />
6271
</Grid>
6372
</Window>
6473
```
@@ -151,7 +160,11 @@ You can customize the appearance and behavior of the `TableView` by modifying it
151160
- **Column Customization**: Define custom columns based on data types.
152161
- **Is ReadOnly**: You can make any column or the TableView itself read only.
153162
- **Sorting and Filtering**: Enable sorting and filtering on specific columns or for the all columns.
154-
- **TableView Options**: Turn on or off options flyout for the TableView based on your requirements.
163+
- **Corner Button Mode**: Use the `CornerButtonMode` property to configure the corner button's behavior. You can select from:
164+
- `None`: No corner button.
165+
- `SelectAll`: Displays a "Select All" button.
166+
- `Options`: Displays an options menu.
167+
- **Column Header and Cell Styles**: Customize the styles for column headers and cells to match your application's theme or specific design requirements.
155168
156169
```xml
157170
<tv:TableView x:Name="MyTableView"
@@ -191,6 +204,10 @@ You can customize the appearance and behavior of the `TableView` by modifying it
191204
192205
Contributions are welcome from the community! If you find any issues or have suggestions for improvements, please submit them through the GitHub issue tracker or consider making a pull request.
193206
207+
#### Contributors
208+
[![ci-build](https://contrib.rocks/image?repo=w-ahmad/WinUI.TableView)](https://github.com/w-ahmad/WinUI.TableView/graphs/contributors)
209+
210+
194211
## License
195212
196213
This project is licensed under the [MIT License](https://github.com/w-ahmad/WinUI.TableView?tab=MIT-1-ov-file).

0 commit comments

Comments
 (0)