openharmony/arkui_advanced_ui_component
1
0
Fork 0
mirror of https://gitee.com/openharmony/arkui_advanced_ui_component synced 2024-11-26 17:00:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

modify doc file

Browse Source 
Signed-off-by: wuyiwuyiwywy <wuyi64@huawei.com>
This commit is contained in:
wuyiwuyiwywy 2023-08-04 09:47:14 +08:00
parent 12bd114444
commit cef81d5bb8
15 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -31,5 +31,5 @@ The following figure shows the directory structure.
With advanced_ui, you can develop your application UI must faster, leveraging its diverse array of UI component combinations with consistent design and style definitions. You can use and reuse any component anywhere as needed.
## How to Use
> See the [doc folder](https://gitee.com/openharmony-sig/arkui_advanced_ui_component/doc).
> See the [doc folder](https://gitee.com/openharmony-sig/arkui_advanced_ui_component/tree/master/doc).

2
README_zh.md
View File

@ -29,6 +29,6 @@ advanced_ui 是基于使用场景设计，为应用提供高效的UI组合，接
advanced_ui框架提供了丰富的、ui设计统一的、高效的UI组合组件、样式定义，组件之间相互独立，随取随用，也可以在需求相同的地方重复使用。开发者可以高效的使用，节省大量的工作量。
## 使用说明
> 见[doc文件夹](https://gitee.com/openharmony-sig/arkui_advanced_ui_component/doc)
> 见[doc文件夹](https://gitee.com/openharmony-sig/arkui_advanced_ui_component/tree/master/doc)

10
doc/ts-composite-components-arkdialog.md
View File

@ -32,7 +32,7 @@ TipsDialog({controller: CustomDialogController, imageRes: Resource, imageSize: S
**装饰器类型：**\@CustomDialog
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**
@ -59,7 +59,7 @@ SelectDialog({controller: CustomDialogController, title: ResourceStr, content?:
**装饰器类型：**\@CustomDialog
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**
@ -81,7 +81,7 @@ ConfirmDialog({controller: CustomDialogController, title: ResourceStr, content?:
**装饰器类型：**\@CustomDialog
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**
@ -104,7 +104,7 @@ AlertDialog({controller: CustomDialogController, content?: ResourceStr, primaryB
**装饰器类型：**\@CustomDialog
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**
@ -130,7 +130,7 @@ LoadingDialog({controller: CustomDialogController, content?: ResourceStr})
## ButtonOptions
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | -------- |

8
doc/ts-composite-components-composelistitem.md
View File

@ -26,7 +26,7 @@ ComposeListItem({contentItem?: ContentItem, operateItem?: OperateItem})
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**
@ -71,9 +71,9 @@ ComposeListItem({contentItem?: ContentItem, operateItem?: OperateItem})
| icon | [OperateIcon](#operateicon) | 否 | 右侧元素-第一个图标，大小为24\*24dp。 |
| subIcon | [OperateIcon](#operateicon) | 否 | 右侧元素-第二个图标，大小为24\*24dp。 |
| button | [OperateButton](#operatebutton) | 否 | 右侧元素-按钮。 |
| switch | [OperateCheck](#switchcheckboxradio-operatecheck) | 否 | 右侧元素-开关。 |
| checkbox | [OperateCheck](#switchcheckboxradio-operatecheck) | 否 | 右侧元素-多选框，大小为24\*24dp。 |
| radio | [OperateCheck](#switchcheckboxradio-operatecheck) | 否 | 右侧元素-单选，大小为24\*24dp。 |
| switch | [OperateCheck](https://gitee.com/openharmony-sig/arkui_advanced_ui_component/blob/master/doc/ts-composite-components-composelistitem.md#switchcheckboxradio-operatecheck) | 否 | 右侧元素-开关。 |
| checkbox | [OperateCheck](https://gitee.com/openharmony-sig/arkui_advanced_ui_component/blob/master/doc/ts-composite-components-composelistitem.md#switchcheckboxradio-operatecheck) | 否 | 右侧元素-多选框，大小为24\*24dp。 |
| radio | [OperateCheck](https://gitee.com/openharmony-sig/arkui_advanced_ui_component/blob/master/doc/ts-composite-components-composelistitem.md#switchcheckboxradio-operatecheck) | 否 | 右侧元素-单选，大小为24\*24dp。 |
| image | [ResourceStr](https://docs.openharmony.cn/pages/v4.0/zh-cn/application-dev/reference/arkui-ts/ts-types.md/#resourcestr) | 否 | 右侧元素-图片，大小为48\*48dp。 |
| text | [ResourceStr](https://docs.openharmony.cn/pages/v4.0/zh-cn/application-dev/reference/arkui-ts/ts-types.md/#resourcestr) | 否 | 右侧元素-文字。 |

2
doc/ts-composite-components-composetitlebar.md
View File

@ -26,7 +26,7 @@ ComposeTitleBar({item?: ComposeTitleBarMenuItem, title: ResourceStr, subtitle?:
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**

2
doc/ts-composite-components-editabletitlebar.md
View File

@ -26,7 +26,7 @@ EditableTitleBar({leftIconType: EditableLeftIconType, title: ResourceStr, menuIt
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**

2
doc/ts-composite-components-filter.md
View File

@ -26,7 +26,7 @@ Filter({ multiFilters: Array&lt;FilterParams&gt;, additionFilters: FilterParams
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**

2
doc/ts-composite-components-progressbutton.md
View File

@ -21,7 +21,7 @@ ProgressButton({progress: number, content: string, progressButtonWidth?: Length,
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**

2
doc/ts-composite-components-selecttitlebar.md
View File

@ -26,7 +26,7 @@ SelectTitleBar({selected: number, options: Array&lt;SelectOption&gt;, menuItems?
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**

2
doc/ts-composite-components-splitlayout.md
View File

@ -26,7 +26,7 @@ SplitLayout({mainImage: Resource, primaryText: string, secondaryText?: string, t
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**

2
doc/ts-composite-components-subheader.md
View File

@ -26,7 +26,7 @@ SubHeader({primaryTitle?: ResourceStr, secondaryTitle?: ResourceStr, icon?: Reso
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**

2
doc/ts-composite-components-swiperefresher.md
View File

@ -26,7 +26,7 @@ SwipeRefresher ({content: string, isLoading: boolean})
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**

6
doc/ts-composite-components-tabtitlebar.md
View File

@ -26,14 +26,14 @@ TabTitleBar({tabItems: Array&lt;TabTitleBarTabItem&gt;, menuItems?: Array&lt;Tab
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**
| 参数名 | 参数类型 | 必选 | 装饰器类型 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| tabItems | Array&lt;TabTitleBarTabItem&gt; | 是 | - | 左侧页签项目列表，定义标题栏左侧的页签项目。 |
| menuItems | Array&lt;TabTitleBarMenuItem&gt; | 否 | - | 右侧菜单项目列表，定义标题栏右侧的菜单项目 |
| tabItems | Array&lt;[TabTitleBarTabItem](https://gitee.com/openharmony-sig/arkui_advanced_ui_component/blob/master/doc/ts-composite-components-tabtitlebar.md/#tabtitlebartabitem)&gt; | 是 | - | 左侧页签项目列表，定义标题栏左侧的页签项目。 |
| menuItems | Array&lt;[TabTitleBarMenuItem](https://gitee.com/openharmony-sig/arkui_advanced_ui_component/blob/master/doc/ts-composite-components-tabtitlebar.md/#tabtitlebarmenuitem)&gt; | 否 | - | 右侧菜单项目列表，定义标题栏右侧的菜单项目 |
| swiperContent | ()&nbsp;=&gt;&nbsp;void | 否 | \@BuilderParam | 页签列表关联的页面内容构造器 |

2
doc/ts-composite-components-toolbar.md
View File

@ -26,7 +26,7 @@ Toolbar({toolBarList: ToolBarOptions, activateIndex?: number, controller: TabsCo
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**

2
doc/ts-composite-components-treeview.md
View File

@ -29,7 +29,7 @@ TreeView({ treeController: TreeController })
**装饰器类型：**\@Component
**系统能力：**SystemCapability.ArkUI.ArkUI.Full
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**参数：**