
HarmonyOS API:容器组件
版本:v3.1 Beta
Row
更新时间: 2023-02-17 09:19
沿水平方向布局容器。
说明
该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
可以包含子组件。
接口
Row(value?:{space?: number | string })
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
space | string | number | 否 | 横向布局元素间距。 从API version 9开始,space为负数时不生效。 默认值:0,单位vp |
属性
名称 | 参数类型 | 描述 |
alignItems | 设置子组件在垂直方向上的对齐格式。 默认值:VerticalAlign.Center | |
justifyContent8+ | 设置子组件在水平方向上的对齐格式。 FlexAlign.Start |
示例
RowSplit
更新时间: 2023-02-17 09:19
将子组件横向布局,并在每个子组件之间插入一根纵向的分割线。
说明
该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
可以包含子组件
接口
RowSplit()
属性
名称 | 参数类型 | 描述 |
resizeable | boolean | 分割线是否可拖拽,默认为false。 |
说明
RowSplit的分割线最小能拖动到刚好包含子组件。
在真机中查看拖动效果,预览器中不支持拖动。
示例
SideBarContainer
更新时间: 2023-02-17 09:19
提供侧边栏可以显示和隐藏的侧边栏容器,通过子组件定义侧边栏和内容区,第一个子组件表示侧边栏,第二个子组件表示内容区。
说明
该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
可以包含子组件。
接口
SideBarContainer( type?: SideBarContainerType )
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
type | SideBarContainerType | 否 | 设置侧边栏的显示类型。 默认值:SideBarContainerType.Embed |
SideBarContainerType枚举说明
名称 | 描述 |
Embed | 侧边栏嵌入到组件内,和内容区并列显示。 |
Overlay | 侧边栏浮在内容区上面。 |
属性
名称 | 参数类型 | 描述 |
showSideBar | boolean | 设置是否显示侧边栏。 默认值:true |
controlButton | ButtonStyle | 设置侧边栏控制按钮的属性。 |
showControlButton | boolean | 设置是否显示控制按钮。 默认值:true |
sideBarWidth | number | Length9+ | 设置侧边栏的宽度。 默认值:200,单位vp |
minSideBarWidth | number | Length9+ | 设置侧边栏最小宽度。 默认值:200,单位vp |
maxSideBarWidth | number | Length9+ | 设置侧边栏最大宽度。 默认值:280,单位vp |
autoHide9+ | boolean | 设置当侧边栏拖拽到小于最小宽度后,是否自动隐藏。 默认值:true |
sideBarPosition9+ | SideBarPosition | 设置侧边栏显示位置。 默认值:SideBarPosition.Start |
ButtonStyle对象说明
名称 | 参数类型 | 必填 | 描述 |
left | number | 否 | 设置侧边栏控制按钮距离容器左界限的间距。 默认值:16,单位vp |
top | number | 否 | 设置侧边栏控制按钮距离容器上界限的间距。 默认值:48,单位vp |
width | number | 否 | 设置侧边栏控制按钮的宽度。 默认值:32,单位vp |
height | number | 否 | 设置侧边栏控制按钮的高度。 默认值:32,单位vp |
icons | { shown: string | PixelMap | Resource , hidden: string | PixelMap | Resource , switching?: string | PixelMap | Resource } | 否 | 设置侧边栏控制按钮的图标: - shown: 设置侧边栏显示时控制按钮的图标。 - hidden: 设置侧边栏隐藏时控制按钮的图标。 - switching:设置侧边栏显示和隐藏状态切换时控制按钮的图标。 |
SideBarPosition9+枚举说明
名称 | 描述 |
Start | 侧边栏位于容器左侧。 |
End | 侧边栏位于容器右侧。 |
事件
名称 | 功能描述 |
onChange(callback: (value: boolean) => void) | 当侧边栏的状态在显示和隐藏之间切换时触发回调。 true表示显示,false表示隐藏。 |
示例
