From bfd6c81b0190a70e30ee276e13fdb5f7ca220042 Mon Sep 17 00:00:00 2001 From: tengfan66 Date: Fri, 30 Jun 2023 10:05:55 +0800 Subject: [PATCH] add sidebar Signed-off-by: tengfan66 --- .../arkui-ts/ts-container-sidebarcontainer.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md index 8860be41a5..95cb90a0f0 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md @@ -45,22 +45,22 @@ SideBarContainer( type?: SideBarContainerType ) | showSideBar | boolean | 设置是否显示侧边栏。
默认值:true
从API version 10开始,该属性支持[$$](../../quick-start/arkts-two-way-sync.md)双向绑定变量。 | | controlButton | [ButtonStyle](#buttonstyle对象说明) | 设置侧边栏控制按钮的属性。 | | showControlButton | boolean | 设置是否显示控制按钮。
默认值:true | -| sideBarWidth | number \| [Length](ts-types.md#length)9+ | 设置侧边栏的宽度。
默认值:200
单位:vp
**说明:**
设置为小于0的值时按默认值显示。
受最小宽度和最大宽度限制,不在限制区域内取最近的点。
sideBarWidth优先于侧边栏子组件width,sideBarWidth未设置时默认值优先级高于侧边栏子组件width。 | -| minSideBarWidth | number \| [Length](ts-types.md#length)9+ | 设置侧边栏最小宽度。
默认值:200,单位vp
**说明:**
设置为小于0的值时按默认值显示。
值不能超过侧边栏容器本身宽度,超过使用侧边栏容器本身宽度。
minSideBarWidth优先于侧边栏子组件minWidth,minSideBarWidth未设置时默认值优先级低于侧边栏子组件minWidth。 | -| maxSideBarWidth | number \| [Length](ts-types.md#length)9+ | 设置侧边栏最大宽度。
默认值:280,单位vp
**说明:**
设置为小于0的值时按默认值显示。
值不能超过侧边栏容器本身宽度,超过使用侧边栏容器本身宽度。
maxSideBarWidth优先于侧边栏子组件maxWidth,maxSideBarWidth未设置时默认值优先级低于侧边栏子组件maxWidth。 | +| sideBarWidth | number \| [Length](ts-types.md#length)9+ | 设置侧边栏的宽度。
默认值:200vp
单位:vp
**说明:**
设置为小于0的值时按默认值显示。
受最小宽度和最大宽度限制,不在限制区域内取最近的点。
sideBarWidth优先于侧边栏子组件width,sideBarWidth未设置时默认值优先级高于侧边栏子组件width。 | +| minSideBarWidth | number \| [Length](ts-types.md#length)9+ | 设置侧边栏最小宽度。
默认值:200vp
单位:vp
**说明:**
设置为小于0的值时按默认值显示。
值不能超过侧边栏容器本身宽度,超过使用侧边栏容器本身宽度。
minSideBarWidth优先于侧边栏子组件minWidth,minSideBarWidth未设置时默认值优先级低于侧边栏子组件minWidth。 | +| maxSideBarWidth | number \| [Length](ts-types.md#length)9+ | 设置侧边栏最大宽度。
默认值:280vp
单位:vp
**说明:**
设置为小于0的值时按默认值显示。
值不能超过侧边栏容器本身宽度,超过使用侧边栏容器本身宽度。
maxSideBarWidth优先于侧边栏子组件maxWidth,maxSideBarWidth未设置时默认值优先级低于侧边栏子组件maxWidth。 | | autoHide9+ | boolean | 设置当侧边栏拖拽到小于最小宽度后,是否自动隐藏。
默认值:true
**说明:**
受minSideBarWidth属性方法影响,minSideBarWidth属性方法未设置值使用默认值。
拖拽过程中判断是否要自动隐藏。小于最小宽度时需要阻尼效果触发隐藏(越界一段距离) | | sideBarPosition9+ | [SideBarPosition](#sidebarposition9枚举说明) | 设置侧边栏显示位置。
默认值:SideBarPosition.Start | | divider10+ | [DividerStyle](#dividerstyle10对象说明) \| null | 设置分割线的样式。
- 默认为DividerStyle:显示分割线。
- null:不显示分割线。 | -| minContentWidth10+ | Dimension | SideBarContainer组件内容区的最小宽度。
默认值:360
单位:vp | +| minContentWidth10+ | Dimension | SideBarContainer组件内容区的最小宽度。
默认值:360vp
单位:vp | ## ButtonStyle对象说明 | 名称 | 参数类型 | 必填 | 描述 | | -------- | -------- | -------- | -------- | -| left | number | 否 | 设置侧边栏控制按钮距离容器左界限的间距。
默认值:16
单位:vp | -| top | number | 否 | 设置侧边栏控制按钮距离容器上界限的间距。
默认值:48
单位:vp | -| width | number | 否 | 设置侧边栏控制按钮的宽度。
默认值:32
单位:vp | -| height | number | 否 | 设置侧边栏控制按钮的高度。
默认值:32
单位:vp | +| left | number | 否 | 设置侧边栏控制按钮距离容器左界限的间距。
默认值:16vp
单位:vp | +| top | number | 否 | 设置侧边栏控制按钮距离容器上界限的间距。
默认值:48vp
单位:vp | +| width | number | 否 | 设置侧边栏控制按钮的宽度。
默认值:
API version 9及之前版本:32vp
从API version 10开始:24vp
单位:vp | +| height | number | 否 | 设置侧边栏控制按钮的高度。
默认值:
API version 9及之前版本:32vp
从API version 10开始:24vp
单位:vp | | icons | {
shown: string \| PixelMap \| [Resource](ts-types.md) ,
hidden: string \| PixelMap \| [Resource](ts-types.md) ,
switching?: string \| PixelMap \| [Resource](ts-types.md)
} | 否 | 设置侧边栏控制按钮的图标:

- shown: 设置侧边栏显示时控制按钮的图标。
**说明:**
资源获取错误时,使用默认图标。
- hidden: 设置侧边栏隐藏时控制按钮的图标。
- switching:设置侧边栏显示和隐藏状态切换时控制按钮的图标。 | ## SideBarPosition9+枚举说明 @@ -74,7 +74,7 @@ SideBarContainer( type?: SideBarContainerType ) | 名称 | 参数类型 | 必填 | 描述 | | ----------- | ------------- | ---- | ---------------------------------------- | -| strokeWidth | [Length](ts-types.md#length) | 是 | 分割线的线宽。
默认值:1
单位:vp | +| strokeWidth | [Length](ts-types.md#length) | 是 | 分割线的线宽。
默认值:1vp
单位:vp | | color | [ResourceColor](ts-types.md#resourcecolor) | 否 | 分割线的颜色。
默认值:#000000,3% | | startMargin | [Length](ts-types.md#length) | 否 | 分割线与侧边栏顶端的距离。
默认值:0 | | endMargin | [Length](ts-types.md#length) | 否 | 分割线与侧边栏底端的距离。
默认值:0 | -- GitLab