提交 bfd6c81b 编写于 作者: T tengfan66

add sidebar

Signed-off-by: Ntengfan66 <tengfan3@huawei.com>
上级 2d8fe695
......@@ -45,22 +45,22 @@ SideBarContainer( type?: SideBarContainerType )
| showSideBar | boolean | 设置是否显示侧边栏。<br/>默认值:true<br />从API version 10开始,该属性支持[$$](../../quick-start/arkts-two-way-sync.md)双向绑定变量。 |
| controlButton | [ButtonStyle](#buttonstyle对象说明) | 设置侧边栏控制按钮的属性。 |
| showControlButton | boolean | 设置是否显示控制按钮。<br/>默认值:true |
| sideBarWidth | number&nbsp;\|&nbsp;[Length](ts-types.md#length)<sup>9+</sup> | 设置侧边栏的宽度。<br/>默认值:200<br/>单位:vp<br/>**说明:** <br/>设置为小于0的值时按默认值显示。<br/>受最小宽度和最大宽度限制,不在限制区域内取最近的点。<br/>sideBarWidth优先于侧边栏子组件width,sideBarWidth未设置时默认值优先级高于侧边栏子组件width。 |
| minSideBarWidth | number&nbsp;\|&nbsp;[Length](ts-types.md#length)<sup>9+</sup> | 设置侧边栏最小宽度。<br/>默认值:200,单位vp<br/>**说明:** <br/>设置为小于0的值时按默认值显示。<br/>值不能超过侧边栏容器本身宽度,超过使用侧边栏容器本身宽度。<br/>minSideBarWidth优先于侧边栏子组件minWidth,minSideBarWidth未设置时默认值优先级低于侧边栏子组件minWidth。 |
| maxSideBarWidth | number&nbsp;\|&nbsp;[Length](ts-types.md#length)<sup>9+</sup> | 设置侧边栏最大宽度。<br/>默认值:280,单位vp<br/>**说明:** <br/>设置为小于0的值时按默认值显示。<br/>值不能超过侧边栏容器本身宽度,超过使用侧边栏容器本身宽度。<br/>maxSideBarWidth优先于侧边栏子组件maxWidth,maxSideBarWidth未设置时默认值优先级低于侧边栏子组件maxWidth。 |
| sideBarWidth | number&nbsp;\|&nbsp;[Length](ts-types.md#length)<sup>9+</sup> | 设置侧边栏的宽度。<br/>默认值:200vp<br/>单位:vp<br/>**说明:** <br/>设置为小于0的值时按默认值显示。<br/>受最小宽度和最大宽度限制,不在限制区域内取最近的点。<br/>sideBarWidth优先于侧边栏子组件width,sideBarWidth未设置时默认值优先级高于侧边栏子组件width。 |
| minSideBarWidth | number&nbsp;\|&nbsp;[Length](ts-types.md#length)<sup>9+</sup> | 设置侧边栏最小宽度。<br/>默认值:200vp<br/>单位:vp<br/>**说明:** <br/>设置为小于0的值时按默认值显示。<br/>值不能超过侧边栏容器本身宽度,超过使用侧边栏容器本身宽度。<br/>minSideBarWidth优先于侧边栏子组件minWidth,minSideBarWidth未设置时默认值优先级低于侧边栏子组件minWidth。 |
| maxSideBarWidth | number&nbsp;\|&nbsp;[Length](ts-types.md#length)<sup>9+</sup> | 设置侧边栏最大宽度。<br/>默认值:280vp<br>单位:vp<br/>**说明:** <br/>设置为小于0的值时按默认值显示。<br/>值不能超过侧边栏容器本身宽度,超过使用侧边栏容器本身宽度。<br/>maxSideBarWidth优先于侧边栏子组件maxWidth,maxSideBarWidth未设置时默认值优先级低于侧边栏子组件maxWidth。 |
| autoHide<sup>9+</sup> | boolean | 设置当侧边栏拖拽到小于最小宽度后,是否自动隐藏。<br/>默认值:true<br>**说明:** <br>受minSideBarWidth属性方法影响,minSideBarWidth属性方法未设置值使用默认值。<br/>拖拽过程中判断是否要自动隐藏。小于最小宽度时需要阻尼效果触发隐藏(越界一段距离) |
| sideBarPosition<sup>9+</sup> | [SideBarPosition](#sidebarposition9枚举说明) | 设置侧边栏显示位置。<br/>默认值:SideBarPosition.Start |
| divider<sup>10+</sup> | [DividerStyle](#dividerstyle10对象说明) \| null | 设置分割线的样式。<br/>- 默认为DividerStyle:显示分割线。<br/>- null:不显示分割线。 |
| minContentWidth<sup>10+</sup> | Dimension | SideBarContainer组件内容区的最小宽度。<br/>默认值:360<br/>单位:vp |
| minContentWidth<sup>10+</sup> | Dimension | SideBarContainer组件内容区的最小宽度。<br/>默认值:360vp<br/>单位:vp |
## ButtonStyle对象说明
| 名称 | 参数类型 | 必填 | 描述 |
| -------- | -------- | -------- | -------- |
| left | number | 否 | 设置侧边栏控制按钮距离容器左界限的间距。<br/>默认值:16<br>单位:vp |
| top | number | 否 | 设置侧边栏控制按钮距离容器上界限的间距。<br/>默认值:48<br/>单位:vp |
| width | number | 否 | 设置侧边栏控制按钮的宽度。<br/>默认值:32<br/>单位:vp |
| height | number | 否 | 设置侧边栏控制按钮的高度。<br/>默认值:32<br/>单位:vp |
| left | number | 否 | 设置侧边栏控制按钮距离容器左界限的间距。<br/>默认值:16vp<br>单位:vp |
| top | number | 否 | 设置侧边栏控制按钮距离容器上界限的间距。<br/>默认值:48vp<br/>单位:vp |
| width | number | 否 | 设置侧边栏控制按钮的宽度。<br/>默认值:<br/>API version 9及之前版本:32vp<br/>从API version 10开始:24vp<br/>单位:vp |
| height | number | 否 | 设置侧边栏控制按钮的高度。<br/>默认值:<br/>API version 9及之前版本:32vp<br/>从API version 10开始:24vp<br/>单位:vp |
| icons | {<br/>shown:&nbsp;string \| PixelMap \| [Resource](ts-types.md) ,<br/>hidden:&nbsp;string \| PixelMap \| [Resource](ts-types.md) ,<br/>switching?:&nbsp;string \| PixelMap \| [Resource](ts-types.md) <br/>} | 否 | 设置侧边栏控制按钮的图标:<br/> </p> - shown: 设置侧边栏显示时控制按钮的图标。<br>**说明:** <br>资源获取错误时,使用默认图标。<br/>- hidden: 设置侧边栏隐藏时控制按钮的图标。<br>- switching:设置侧边栏显示和隐藏状态切换时控制按钮的图标。 |
## SideBarPosition<sup>9+</sup>枚举说明
......@@ -74,7 +74,7 @@ SideBarContainer( type?: SideBarContainerType )
| 名称 | 参数类型 | 必填 | 描述 |
| ----------- | ------------- | ---- | ---------------------------------------- |
| strokeWidth | [Length](ts-types.md#length) | 是 | 分割线的线宽。<br/>默认值:1<br/>单位:vp |
| strokeWidth | [Length](ts-types.md#length) | 是 | 分割线的线宽。<br/>默认值:1vp<br/>单位:vp |
| color | [ResourceColor](ts-types.md#resourcecolor) | 否 | 分割线的颜色。<br/>默认值:#000000,3% |
| startMargin | [Length](ts-types.md#length) | 否 | 分割线与侧边栏顶端的距离。<br/>默认值:0 |
| endMargin | [Length](ts-types.md#length) | 否 | 分割线与侧边栏底端的距离。<br/>默认值:0 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册