From bb3e379ed422f284e0a6f11496481ff41b869c56 Mon Sep 17 00:00:00 2001 From: guanguanchuangyu <3246907890@qq.com> Date: Sun, 8 Dec 2019 22:33:00 +0800 Subject: [PATCH 1/5] doc of attach/tipElement doc of native_controls/listview,menu,passwordbox --- .../handycontrol/attach/tipElement/index.md | 41 +++++++++- .../native_controls/listView/index.md | 22 ++++- .../native_controls/menu/index.md | 81 ++++++++++++++++++- .../native_controls/passwordBox/index.md | 45 ++++++++++- .../native_controls/progressBar/index.md | 3 +- 5 files changed, 182 insertions(+), 10 deletions(-) diff --git a/doc/source/handycontrol/attach/tipElement/index.md b/doc/source/handycontrol/attach/tipElement/index.md index ca12ad62..6b91f48d 100644 --- a/doc/source/handycontrol/attach/tipElement/index.md +++ b/doc/source/handycontrol/attach/tipElement/index.md @@ -1,5 +1,42 @@ --- -title: 建设中 +title: TipElement 提示元素 --- -建设中 \ No newline at end of file +# 属性 + +| 名称 | 用途 | +| ---------- | -------- | +| Placement | 提示元素显示位置 | +| Visibility | 是否可见 | + + +# 使用案例 + +## Placement 提示元素显示位置 + +该属性,用于设定提示元素显示位置,目前支持BottomRight和TopLeft(默认值) + +``` + + +``` + +效果 + +![TipElement.Default](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/attach/TipElement.Default.png) + +![TipElement.TopLeft](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/attach/TipElement.TopLeft.png) + diff --git a/doc/source/handycontrol/native_controls/listView/index.md b/doc/source/handycontrol/native_controls/listView/index.md index ca12ad62..308ecd17 100644 --- a/doc/source/handycontrol/native_controls/listView/index.md +++ b/doc/source/handycontrol/native_controls/listView/index.md @@ -1,5 +1,23 @@ --- -title: 建设中 +title: ListView 列表视图 --- -建设中 \ No newline at end of file +`HandyControl`中仅仅提供了一个默认的`ListView`的资源样式,可根据个人需求,自行定义 + +# 案例 + +``` + + + + + + + + + +``` + + + +![ListView.DefaultStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ListView.DefaultStyle.png) \ No newline at end of file diff --git a/doc/source/handycontrol/native_controls/menu/index.md b/doc/source/handycontrol/native_controls/menu/index.md index ca12ad62..33edb44e 100644 --- a/doc/source/handycontrol/native_controls/menu/index.md +++ b/doc/source/handycontrol/native_controls/menu/index.md @@ -1,5 +1,82 @@ --- -title: 建设中 +title: Menu 菜单 --- -建设中 \ No newline at end of file +# MenuBaseStyle + +`HandyControl`中的菜单默认样式,一般不建议直接使用,而是选择继承,便于个人自定义风格 + +样式 + +```xml + +``` + +# 其他样式 + +`HandyControl`中自带的其他样式和效果,其中包含如下样式: + +| 样式Key | 用途 | +| ------------------ | ---- | +| ProgressBarSuccess | 成功色进度条 | +| ProgressBarInfo | 提示色进度条 | +| ProgressBarWarning | 警告色进度条 | +| ProgressBarDanger | 危险色进度条 | +| ProgressBarPrimaryStripe | 主题色条纹进度条 | +| ProgressBarSuccessStripe | 成功色条纹进度条 | +| ProgressBarInfoStripe | 信息色条纹进度条 | +| ProgressBarWarningStripe | 警告色条纹进度条 | +| ProgressBarDangerStripe | 危险色条纹进度条 | +| ProgressBarFlat | 扁平风格 | + +案例: +```xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` +效果: +![ProgressBar.Styles](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ProgressBar.Styles.png) + +# 温馨提示 + +对于进度条进度颜色、圆角以及其他样式的个人使用需求,可查看`HandyControl`开源目中的[源码样式部分](https://github.com/HandyOrg/HandyControl/blob/master/src/Shared/HandyControl_Shared/Themes/Styles/ProgressBar.xaml)自行定义 + From 585f49306e38032b5b089dda2a390f8bdb03d331 Mon Sep 17 00:00:00 2001 From: guanguanchuangyu <3246907890@qq.com> Date: Mon, 23 Dec 2019 22:07:08 +0800 Subject: [PATCH 3/5] reset The progressbar.md --- .../native_controls/progressBar/index.md | 85 ------------------- 1 file changed, 85 deletions(-) diff --git a/doc/source/handycontrol/native_controls/progressBar/index.md b/doc/source/handycontrol/native_controls/progressBar/index.md index 4e37ca4c..e69de29b 100644 --- a/doc/source/handycontrol/native_controls/progressBar/index.md +++ b/doc/source/handycontrol/native_controls/progressBar/index.md @@ -1,85 +0,0 @@ ---- -title: ProgressBar 进度条 ---- - -# ProgressBarBaseStyle - -`HandyControl`中自带的默认样式,不建议直接使用而是选择继承的方式,案例如下: - -``` - -``` - -# 其他样式 - -`HandyControl`中自带的其他样式和效果,其中包含如下样式: - -| 样式Key | 用途 | -| ------------------ | ---- | -| ProgressBarSuccess | 成功色进度条 | -| ProgressBarInfo | 提示色进度条 | -| ProgressBarWarning | 警告色进度条 | -| ProgressBarDanger | 危险色进度条 | -| ProgressBarPrimaryStripe | 主题色条纹进度条 | -| ProgressBarSuccessStripe | 成功色条纹进度条 | -| ProgressBarInfoStripe | 信息色条纹进度条 | -| ProgressBarWarningStripe | 警告色条纹进度条 | -| ProgressBarDangerStripe | 危险色条纹进度条 | -| ProgressBarFlat | 扁平风格 | - -案例: -```xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` -效果: -![ProgressBar.Styles](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ProgressBar.Styles.png) - -# 温馨提示 - -对于进度条进度颜色、圆角以及其他样式的个人使用需求,可查看`HandyControl`开源目中的[源码样式部分](https://github.com/HandyOrg/HandyControl/blob/master/src/Shared/HandyControl_Shared/Themes/Styles/ProgressBar.xaml)自行定义 - From dd45e7e32314211e1b49dbc2e81c3f50ed159e16 Mon Sep 17 00:00:00 2001 From: guanguanchuangyu <3246907890@qq.com> Date: Mon, 23 Dec 2019 22:07:51 +0800 Subject: [PATCH 4/5] add doc of native_controls.progressbar.md --- .../native_controls/progressBar/index.md | 85 +++++++++++++++++++ 1 file changed, 85 insertions(+) diff --git a/doc/source/handycontrol/native_controls/progressBar/index.md b/doc/source/handycontrol/native_controls/progressBar/index.md index e69de29b..4e37ca4c 100644 --- a/doc/source/handycontrol/native_controls/progressBar/index.md +++ b/doc/source/handycontrol/native_controls/progressBar/index.md @@ -0,0 +1,85 @@ +--- +title: ProgressBar 进度条 +--- + +# ProgressBarBaseStyle + +`HandyControl`中自带的默认样式,不建议直接使用而是选择继承的方式,案例如下: + +``` + +``` + +# 其他样式 + +`HandyControl`中自带的其他样式和效果,其中包含如下样式: + +| 样式Key | 用途 | +| ------------------ | ---- | +| ProgressBarSuccess | 成功色进度条 | +| ProgressBarInfo | 提示色进度条 | +| ProgressBarWarning | 警告色进度条 | +| ProgressBarDanger | 危险色进度条 | +| ProgressBarPrimaryStripe | 主题色条纹进度条 | +| ProgressBarSuccessStripe | 成功色条纹进度条 | +| ProgressBarInfoStripe | 信息色条纹进度条 | +| ProgressBarWarningStripe | 警告色条纹进度条 | +| ProgressBarDangerStripe | 危险色条纹进度条 | +| ProgressBarFlat | 扁平风格 | + +案例: +```xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` +效果: +![ProgressBar.Styles](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ProgressBar.Styles.png) + +# 温馨提示 + +对于进度条进度颜色、圆角以及其他样式的个人使用需求,可查看`HandyControl`开源目中的[源码样式部分](https://github.com/HandyOrg/HandyControl/blob/master/src/Shared/HandyControl_Shared/Themes/Styles/ProgressBar.xaml)自行定义 + From cef6fd433ef5a258ba70bb501fa9b203638b53c8 Mon Sep 17 00:00:00 2001 From: NaBian <836904362@qq.com> Date: Sun, 5 Jan 2020 22:31:29 +0800 Subject: [PATCH 5/5] modified doc uniform doc structure --- .../native_controls/label/index.md | 2 +- .../native_controls/listView/index.md | 14 ++-- .../native_controls/menu/index.md | 73 ++----------------- .../native_controls/passwordBox/index.md | 39 +++++----- .../native_controls/progressBar/index.md | 36 ++++----- 5 files changed, 49 insertions(+), 115 deletions(-) diff --git a/doc/source/handycontrol/native_controls/label/index.md b/doc/source/handycontrol/native_controls/label/index.md index 25b65927..cbd200ed 100644 --- a/doc/source/handycontrol/native_controls/label/index.md +++ b/doc/source/handycontrol/native_controls/label/index.md @@ -4,7 +4,7 @@ title: Lable标签 # LabelBaseStyle -Label标签 默认样式,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 +Label标签默认样式,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 {% note info no-icon %} 用例: diff --git a/doc/source/handycontrol/native_controls/listView/index.md b/doc/source/handycontrol/native_controls/listView/index.md index 308ecd17..10c9d1cb 100644 --- a/doc/source/handycontrol/native_controls/listView/index.md +++ b/doc/source/handycontrol/native_controls/listView/index.md @@ -2,11 +2,11 @@ title: ListView 列表视图 --- -`HandyControl`中仅仅提供了一个默认的`ListView`的资源样式,可根据个人需求,自行定义 +`HandyControl`中仅提供了一个默认的`ListView`样式,可根据个人需求,自行定义。 -# 案例 - -``` +{% note info no-icon %} +用例: +{% code %} @@ -16,8 +16,8 @@ title: ListView 列表视图 -``` +{% endcode %} +![ListView.DefaultStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ListView.DefaultStyle.png) - -![ListView.DefaultStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ListView.DefaultStyle.png) \ No newline at end of file +{% endnote %} \ No newline at end of file diff --git a/doc/source/handycontrol/native_controls/menu/index.md b/doc/source/handycontrol/native_controls/menu/index.md index 33edb44e..28d0237f 100644 --- a/doc/source/handycontrol/native_controls/menu/index.md +++ b/doc/source/handycontrol/native_controls/menu/index.md @@ -4,79 +4,20 @@ title: Menu 菜单 # MenuBaseStyle -`HandyControl`中的菜单默认样式,一般不建议直接使用,而是选择继承,便于个人自定义风格 +菜单默认样式,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 -样式 - -```xml - -``` +进度条默认样式,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 # 其他样式 `HandyControl`中自带的其他样式和效果,其中包含如下样式: -| 样式Key | 用途 | -| ------------------ | ---- | -| ProgressBarSuccess | 成功色进度条 | -| ProgressBarInfo | 提示色进度条 | -| ProgressBarWarning | 警告色进度条 | -| ProgressBarDanger | 危险色进度条 | -| ProgressBarPrimaryStripe | 主题色条纹进度条 | -| ProgressBarSuccessStripe | 成功色条纹进度条 | -| ProgressBarInfoStripe | 信息色条纹进度条 | -| ProgressBarWarningStripe | 警告色条纹进度条 | -| ProgressBarDangerStripe | 危险色条纹进度条 | -| ProgressBarFlat | 扁平风格 | +| 样式Key | 用途 |父样式| +| ------------------ | ---- || +| ProgressBarSuccess | 成功色进度条 |ProgressBarBaseStyle| +| ProgressBarInfo | 提示色进度条 |ProgressBarBaseStyle| +| ProgressBarWarning | 警告色进度条 |ProgressBarBaseStyle| +| ProgressBarDanger | 危险色进度条 |ProgressBarBaseStyle| +| ProgressBarStripeBaseStyle | 条纹进度条默认样式(不推荐直接使用) |-| +| ProgressBarPrimaryStripe | 主题色条纹进度条 |ProgressBarStripeBaseStyle| +| ProgressBarSuccessStripe | 成功色条纹进度条 |ProgressBarStripeBaseStyle| +| ProgressBarInfoStripe | 信息色条纹进度条 |ProgressBarStripeBaseStyle| +| ProgressBarWarningStripe | 警告色条纹进度条 |ProgressBarStripeBaseStyle| +| ProgressBarDangerStripe | 危险色条纹进度条 |ProgressBarStripeBaseStyle| +| ProgressBarFlat | 扁平风格 |-| 案例: ```xml @@ -81,5 +76,4 @@ title: ProgressBar 进度条 # 温馨提示 -对于进度条进度颜色、圆角以及其他样式的个人使用需求,可查看`HandyControl`开源目中的[源码样式部分](https://github.com/HandyOrg/HandyControl/blob/master/src/Shared/HandyControl_Shared/Themes/Styles/ProgressBar.xaml)自行定义 - +对于颜色、圆角或其它自定义需求,可参考[进度条样式源码](https://github.com/HandyOrg/HandyControl/blob/master/src/Shared/HandyControl_Shared/Themes/Styles/ProgressBar.xaml)自行定义。 \ No newline at end of file