Skip to content

Commit c2d5a2f

Browse files
jevonsflashjevonsflash
committed
doc: add English Readme
1 parent ff71c59 commit c2d5a2f

2 files changed

Lines changed: 160 additions & 52 deletions

File tree

‎README.md‎

Lines changed: 51 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,84 @@
1-
21
# V-Control
32

4-
[![许可证](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)](https://github.com/jevonsflash/VControl/blob/master/LICENSE)
3+
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)](https://github.com/jevonsflash/VControl/blob/master/LICENSE)
54
[![nuget](https://img.shields.io/nuget/v/VControl.svg?style=for-the-badge)](https://www.nuget.org/packages/VControl)
65
![codeSize](https://img.shields.io/github/languages/code-size/jevonsflash/VControl.svg?style=for-the-badge)
7-
![编程语言](https://img.shields.io/github/languages/top/jevonsflash/VControl.svg?style=for-the-badge)
6+
![Programming Language](https://img.shields.io/github/languages/top/jevonsflash/VControl.svg?style=for-the-badge)
7+
8+
English | [中文](README_zh.md)
89

9-
V-Control是适用于[.NET MAUI](https://dotnet.microsoft.com/zh-cn/apps/maui) 的组件库(Component)，它提供了一组开箱即用的 UI 控件，可快速搭建面向业务的应用程序界面。
10+
V-Control is a component library for [ .NET MAUI](https://dotnet.microsoft.com/zh-cn/apps/maui), providing a set of out-of-the-box UI controls to quickly build business-oriented app interfaces.
1011

1112
![alt text](/docs/assets/banner.png)
1213

1314

14-
## 功能
15-
16-
* [VButton](https://vcontrol.matoapp.net/documents/v-button) - 按钮组件
17-
* VCard - 卡片组件
18-
* [VCheckableCollection](https://vcontrol.matoapp.net/documents/v-checkable-collection) - 可勾选的集合组件
19-
* [VCheckBox](https://vcontrol.matoapp.net/documents/v-checkbox) - 复选框组件
20-
* [VCheckBoxButton](https://vcontrol.matoapp.net/documents/v-checkbox-button) - 复选框按钮组件
21-
* [VCheckBoxGroup](https://vcontrol.matoapp.net/documents/v-checkbox-group) - 复选框集合组件
22-
* [VCollection](https://vcontrol.matoapp.net/documents/v-collection) - 集合视图组件
23-
* VDateNativePicker - 原生封装的日期选择器组件
24-
* [VDatePicker](https://vcontrol.matoapp.net/documents/v-date-picker) - 日期选择器组件
25-
* [VEditor](https://vcontrol.matoapp.net/documents/v-editor) - 编辑器组件
26-
* [VExpander](https://vcontrol.matoapp.net/documents/v-expander) - 展开收起组件
27-
* [VFormItem](https://vcontrol.matoapp.net/documents/v-form-item) - 表单组件
28-
* VIndicator - 进度指示器组件
29-
* [VMenuCell](https://vcontrol.matoapp.net/documents/v-menu-cell) - 菜单项组件
30-
* [VNumberEntry](https://vcontrol.matoapp.net/documents/v-number-entry) - 数字输入框组件
31-
* [VPicker](https://vcontrol.matoapp.net/documents/v-picker) - 选择器组件
32-
* VRadioButton - 单选框组件
33-
* [VRadioButtonGroup](https://vcontrol.matoapp.net/documents/v-radio-button-group) - 单选框集合组件（切换栏组件）
34-
* [VSearchBar](https://vcontrol.matoapp.net/documents/v-search-bar) - 搜索栏组件
35-
* [VTagPicker](https://vcontrol.matoapp.net/documents/v-tag-picker) - 标签选择器组件
36-
* [VTimeLine](https://vcontrol.matoapp.net/documents/v-time-line) - 时间轴组件
37-
* [VTopAppBar](https://vcontrol.matoapp.net/documents/v-top-app-bar) - 顶栏组件
38-
* VTouchContentView - 手势监听组件
39-
* VUploader - 文件上传组件
40-
* [VValidatingEntry](https://vcontrol.matoapp.net/documents/v-validating-entry) - 带验证的输入框组件
41-
* [VValidatingPicker](https://vcontrol.matoapp.net/documents/v-validating-picker) - 带验证的选择器组件
42-
* [VRichTextEditor](https://vcontrol.matoapp.net/documents/v-rich-text-editor) - 富文本编辑器组件
43-
* [VEntry](https://vcontrol.matoapp.net/documents/v-entry) - 输入框组件
44-
* [VPlaceholderView](https://vcontrol.matoapp.net/documents/v-placeholder-view) - 占位视图组件
15+
## Features
16+
17+
* [VButton](https://vcontrol.matoapp.net/documents/v-button) - Button Component
18+
* VCard - Card Component
19+
* [VCheckableCollection](https://vcontrol.matoapp.net/documents/v-checkable-collection) - Checkable Collection Component
20+
* [VCheckBox](https://vcontrol.matoapp.net/documents/v-checkbox) - Checkbox Component
21+
* [VCheckBoxButton](https://vcontrol.matoapp.net/documents/v-checkbox-button) - Checkbox Button Component
22+
* [VCheckBoxGroup](https://vcontrol.matoapp.net/documents/v-checkbox-group) - Checkbox Group Component
23+
* [VCollection](https://vcontrol.matoapp.net/documents/v-collection) - Collection View Component
24+
* VDateNativePicker - Native Date Picker Component
25+
* [VDatePicker](https://vcontrol.matoapp.net/documents/v-date-picker) - Date Picker Component
26+
* [VEditor](https://vcontrol.matoapp.net/documents/v-editor) - Editor Component
27+
* [VExpander](https://vcontrol.matoapp.net/documents/v-expander) - Expander Component
28+
* [VFormItem](https://vcontrol.matoapp.net/documents/v-form-item) - Form Component
29+
* VIndicator - Progress Indicator Component
30+
* [VMenuCell](https://vcontrol.matoapp.net/documents/v-menu-cell) - Menu Item Component
31+
* [VNumberEntry](https://vcontrol.matoapp.net/documents/v-number-entry) - Number Entry Component
32+
* [VPicker](https://vcontrol.matoapp.net/documents/v-picker) - Picker Component
33+
* VRadioButton - Radio Button Component
34+
* [VRadioButtonGroup](https://vcontrol.matoapp.net/documents/v-radio-button-group) - Radio Button Group Component (Toggle Bar)
35+
* [VSearchBar](https://vcontrol.matoapp.net/documents/v-search-bar) - Search Bar Component
36+
* [VTagPicker](https://vcontrol.matoapp.net/documents/v-tag-picker) - Tag Picker Component
37+
* [VTimeLine](https://vcontrol.matoapp.net/documents/v-time-line) - Timeline Component
38+
* [VTopAppBar](https://vcontrol.matoapp.net/documents/v-top-app-bar) - Top App Bar Component
39+
* VTouchContentView - Gesture Listener Component
40+
* VUploader - File Upload Component
41+
* [VValidatingEntry](https://vcontrol.matoapp.net/documents/v-validating-entry) - Validating Entry Component
42+
* [VValidatingPicker](https://vcontrol.matoapp.net/documents/v-validating-picker) - Validating Picker Component
43+
* [VRichTextEditor](https://vcontrol.matoapp.net/documents/v-rich-text-editor) - Rich Text Editor Component
44+
* [VEntry](https://vcontrol.matoapp.net/documents/v-entry) - Entry Component
45+
* [VPlaceholderView](https://vcontrol.matoapp.net/documents/v-placeholder-view) - Placeholder View Component
4546

4647

4748
## Todo
4849

49-
* VAutocomplete - 自动完成组件
50-
* VComparisonView - 比较视图组件
51-
* VCalendar - 日历组件
52-
* 暗黑模式
53-
* 基于 BlazorApp 的组件
50+
* VAutocomplete - Autocomplete Component
51+
* VComparisonView - Comparison View Component
52+
* VCalendar - Calendar Component
53+
* Dark Mode
54+
* BlazorApp-based Components
5455

55-
## 快速开始
56+
## Quick Start
5657

57-
1. 在你的.NET MAUI 项目中执行以下命令来安装 V-Control：
58+
1. Run the following command in your .NET MAUI project to install V-Control:
5859

5960
```bash
6061
dotnet add package VControl
6162
```
6263

63-
或在NUGET中搜索"V-Control"并安装它。
64-
65-
66-
2. 在 `MauiProgram` 使用`.UseVControl()`在MauiAppBuilder中添加V-Control的处理程序。
64+
Or search for "V-Control" in NUGET and install it.
6765

6866

67+
2. In `MauiProgram`, use `.UseVControl()` to add the V-Control handler in the MauiAppBuilder.
6968

7069
```csharp
7170
public static MauiApp CreateMauiApp()
7271
{
7372
var builder = MauiApp.CreateBuilder();
7473
builder
7574
.UseMauiApp<App>()
76-
.UseVControl() //👈在这里添加V-Control的处理程序
75+
.UseVControl() //👈 Add V-Control handler here
7776
var mauiApp = builder.Build();
7877
return mauiApp;
7978
}
8079
```
8180

82-
3. 打开 `App.xaml` 文件， 在资源中添加`<v:VControlTheme />`。
81+
3. Open the `App.xaml` file and add `<v:VControlTheme />` to the resources.
8382

8483
```xml
8584

@@ -95,13 +94,13 @@ public static MauiApp CreateMauiApp()
9594

9695
```
9796

98-
## 文档
97+
## Documentation
9998

100-
前往[V-Control Docs](https://vcontrol.matoapp.net/documents/starter)
99+
Visit [V-Control Docs](https://vcontrol.matoapp.net/documents/starter)
101100

102-
## 源码和示例
101+
## Source Code and Samples
103102

104-
您可以前往[GitHub](https://github.com/jevonsflash/VControl)查看V-Control的源码和示例。
103+
You can visit the [GitHub](https://github.com/jevonsflash/VControl) to view the source code and examples for V-Control.
105104

106105
## Stargazers over time
107106
[![Stargazers over time](https://starchart.cc/jevonsflash/V-Control.svg?variant=adaptive)](https://starchart.cc/jevonsflash/V-Control)

‎README_zh.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
2+
# V-Control
3+
4+
[![许可证](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)](https://github.com/jevonsflash/VControl/blob/master/LICENSE)
5+
[![nuget](https://img.shields.io/nuget/v/VControl.svg?style=for-the-badge)](https://www.nuget.org/packages/VControl)
6+
![codeSize](https://img.shields.io/github/languages/code-size/jevonsflash/VControl.svg?style=for-the-badge)
7+
![编程语言](https://img.shields.io/github/languages/top/jevonsflash/VControl.svg?style=for-the-badge)
8+
9+
[English](README.md) | 中文
10+
11+
V-Control是适用于[.NET MAUI](https://dotnet.microsoft.com/zh-cn/apps/maui) 的组件库(Component)，它提供了一组开箱即用的 UI 控件，可快速搭建面向业务的应用程序界面。
12+
13+
![alt text](/docs/assets/banner.png)
14+
15+
16+
## 功能
17+
18+
* [VButton](https://vcontrol.matoapp.net/documents/v-button) - 按钮组件
19+
* VCard - 卡片组件
20+
* [VCheckableCollection](https://vcontrol.matoapp.net/documents/v-checkable-collection) - 可勾选的集合组件
21+
* [VCheckBox](https://vcontrol.matoapp.net/documents/v-checkbox) - 复选框组件
22+
* [VCheckBoxButton](https://vcontrol.matoapp.net/documents/v-checkbox-button) - 复选框按钮组件
23+
* [VCheckBoxGroup](https://vcontrol.matoapp.net/documents/v-checkbox-group) - 复选框集合组件
24+
* [VCollection](https://vcontrol.matoapp.net/documents/v-collection) - 集合视图组件
25+
* VDateNativePicker - 原生封装的日期选择器组件
26+
* [VDatePicker](https://vcontrol.matoapp.net/documents/v-date-picker) - 日期选择器组件
27+
* [VEditor](https://vcontrol.matoapp.net/documents/v-editor) - 编辑器组件
28+
* [VExpander](https://vcontrol.matoapp.net/documents/v-expander) - 展开收起组件
29+
* [VFormItem](https://vcontrol.matoapp.net/documents/v-form-item) - 表单组件
30+
* VIndicator - 进度指示器组件
31+
* [VMenuCell](https://vcontrol.matoapp.net/documents/v-menu-cell) - 菜单项组件
32+
* [VNumberEntry](https://vcontrol.matoapp.net/documents/v-number-entry) - 数字输入框组件
33+
* [VPicker](https://vcontrol.matoapp.net/documents/v-picker) - 选择器组件
34+
* VRadioButton - 单选框组件
35+
* [VRadioButtonGroup](https://vcontrol.matoapp.net/documents/v-radio-button-group) - 单选框集合组件（切换栏组件）
36+
* [VSearchBar](https://vcontrol.matoapp.net/documents/v-search-bar) - 搜索栏组件
37+
* [VTagPicker](https://vcontrol.matoapp.net/documents/v-tag-picker) - 标签选择器组件
38+
* [VTimeLine](https://vcontrol.matoapp.net/documents/v-time-line) - 时间轴组件
39+
* [VTopAppBar](https://vcontrol.matoapp.net/documents/v-top-app-bar) - 顶栏组件
40+
* VTouchContentView - 手势监听组件
41+
* VUploader - 文件上传组件
42+
* [VValidatingEntry](https://vcontrol.matoapp.net/documents/v-validating-entry) - 带验证的输入框组件
43+
* [VValidatingPicker](https://vcontrol.matoapp.net/documents/v-validating-picker) - 带验证的选择器组件
44+
* [VRichTextEditor](https://vcontrol.matoapp.net/documents/v-rich-text-editor) - 富文本编辑器组件
45+
* [VEntry](https://vcontrol.matoapp.net/documents/v-entry) - 输入框组件
46+
* [VPlaceholderView](https://vcontrol.matoapp.net/documents/v-placeholder-view) - 占位视图组件
47+
48+
49+
## Todo
50+
51+
* VAutocomplete - 自动完成组件
52+
* VComparisonView - 比较视图组件
53+
* VCalendar - 日历组件
54+
* 暗黑模式
55+
* 基于 BlazorApp 的组件
56+
57+
## 快速开始
58+
59+
1. 在你的.NET MAUI 项目中执行以下命令来安装 V-Control：
60+
61+
```bash
62+
dotnet add package VControl
63+
```
64+
65+
或在NUGET中搜索"V-Control"并安装它。
66+
67+
68+
2. 在 `MauiProgram` 使用`.UseVControl()`在MauiAppBuilder中添加V-Control的处理程序。
69+
70+
71+
72+
```csharp
73+
public static MauiApp CreateMauiApp()
74+
{
75+
var builder = MauiApp.CreateBuilder();
76+
builder
77+
.UseMauiApp<App>()
78+
.UseVControl() //👈在这里添加V-Control的处理程序
79+
var mauiApp = builder.Build();
80+
return mauiApp;
81+
}
82+
```
83+
84+
3. 打开 `App.xaml` 文件， 在资源中添加`<v:VControlTheme />`。
85+
86+
```xml
87+
88+
<?xml version = "1.0" encoding = "UTF-8" ?>
89+
<Application xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
90+
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
91+
xmlns:v="clr-namespace:VControl.Styles;assembly=VControl">
92+
<Application.Resources>
93+
<v:VControlTheme />
94+
...
95+
</Application.Resources>
96+
</Application>
97+
98+
```
99+
100+
## 文档
101+
102+
前往[V-Control Docs](https://vcontrol.matoapp.net/documents/starter)
103+
104+
## 源码和示例
105+
106+
您可以前往[GitHub](https://github.com/jevonsflash/VControl)查看V-Control的源码和示例。
107+
108+
## Stargazers over time
109+
[![Stargazers over time](https://starchart.cc/jevonsflash/V-Control.svg?variant=adaptive)](https://starchart.cc/jevonsflash/V-Control)

0 commit comments

Comments
 (0)