GridCol
栅格子组件,必须作为栅格容器组件(GridRow)的子组件使用。
说明:
该组件从API version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
可以包含单个子组件。
接口
GridCol(option?: GridColOptions)
栅格列布局组件。
卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| option | GridColOptions | 否 | 栅格布局子组件参数。 |
GridColOptions对象说明
设置栅格列布局组件布局选项。
卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| span | number | GridColColumnOption | 否 | 是 | 栅格子组件占用栅格容器组件的列数。span为0表示该元素不参与布局计算,即不会被渲染。 取值为非负的整数,默认值:1 非法值:按默认值处理。 |
| offset | number | GridColColumnOption | 否 | 是 | 栅格子组件相对于原本位置偏移的列数。 取值为非负的整数,默认值:0 非法值:按默认值处理。 |
| order | number | GridColColumnOption | 否 | 是 | 元素的序号,根据栅格子组件的序号,从小到大对栅格子组件做排序。 取值为非负的整数,默认值:0 非法值:按默认值处理。 说明: 当子组件不设置order或者设置相同的order,子组件按照代码顺序展示。 当子组件部分设置order,部分不设置order时,未设置order的子组件依次排序靠前,设置了order的子组件按照数值从小到大排列。 |
span、offset、order属性按照xs、sm、md、lg、xl、xxl的顺序具有“继承性”,未设置值的断点将会从前一个断点取值。
属性
除支持通用属性外,还支持以下属性:
span
span(value: number | GridColColumnOption)
设置占用列数。span为0,意味着该元素不参与布局计算,即不会被渲染。
卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | GridColColumnOption | 是 | 占用列数。 取值为非负整数,默认值:1 |
gridColOffset
gridColOffset(value: number | GridColColumnOption)
设置相对于前一个栅格子组件偏移的列数。
卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | GridColColumnOption | 是 | 相对于前一个栅格子组件偏移的列数。 取值为非负整数,默认值:0 非法值:按默认值处理。 |
order
order(value: number | GridColColumnOption)
设置栅格子组件的序号,根据序号从小到大对栅格子组件进行排序。
卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | GridColColumnOption | 是 | 元素的序号,根据栅格子组件的序号,从小到大对栅格子组件做排序。 取值为非负整数,默认值:0 非法值:按默认值处理。 |
GridColColumnOption
用于自定义指定在不同宽度设备类型上,栅格子组件占据的栅格数量单位。
卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| xs | number | 否 | 是 | 在栅格大小为xs的设备上,栅格容器组件的栅格列数。 |
| sm | number | 否 | 是 | 在栅格大小为sm的设备上,栅格容器组件的栅格列数。 |
| md | number | 否 | 是 | 在栅格大小为md的设备上,栅格容器组件的栅格列数。 |
| lg | number | 否 | 是 | 在栅格大小为lg的设备上,栅格容器组件的栅格列数。 |
| xl | number | 否 | 是 | 在栅格大小为xl的设备上,栅格容器组件的栅格列数。 |
| xxl | number | 否 | 是 | 在栅格大小为xxl的设备上,栅格容器组件的栅格列数。 |
事件
支持通用事件。
示例
请参考栅格容器示例代码(GridRow)。