GridCol

The GridCol component must be used as a child component of the GridRow container.

NOTE

This component is supported since API version 9. Updates will be marked with a superscript to indicate their earliest API version.

Child Components

This component can contain only one child component.

APIs

GridCol(option?: GridColOptions)

Creates a GridCol component.

Widget capability: This API can be used in ArkTS widgets since API version 9.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.ArkUI.ArkUI.Full

Parameters

Name	Type	Mandatory	Description
option	GridColOptions	No	Options of the GridCol component.

GridColOptions

Defines the options of the GridCol component.

Widget capability: This API can be used in ArkTS widgets since API version 9.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.ArkUI.ArkUI.Full

Name	Type	Mandatory	Description
span	number \|GridColColumnOption	No	Number of columns occupied by the component. If it is set to 0, the component is not involved in layout calculation, that is, the component is not rendered. The value is an integer greater than 0. Default value: 1.
offset	number \|GridColColumnOption	No	Number of offset columns relative to the original position of the component. The value is an integer greater than 0. Default value: 0.
order	number \|GridColColumnOption	No	Sequence number of the component. Child components of the grid are sorted in ascending order based on their sequence numbers. The value is an integer greater than 0. Default value: 0. NOTE If a child component shares an order value with another child component or does not have order set, it is displayed based on its code sequence number. If order is not set for all child components, those that have order set are displayed after those that do not and are sorted in ascending order based on the value.

The values of span, offset, and order attributes are inherited in the sequence of xs, sm, md, lg, xl, and xxl. If no value is set for a breakpoint, the value is obtained from the previous breakpoint.

Attributes

In addition to the universal attributes, the following attributes are supported.

span

span(value: number|GridColColumnOption)

Sets the number of columns occupied by the component. If it is set to 0, the element is not involved in layout calculation, that is, the element is not rendered.

Widget capability: This API can be used in ArkTS widgets since API version 9.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.ArkUI.ArkUI.Full

Parameters

Name	Type	Mandatory	Description
value	number \|GridColColumnOption	Yes	Number of occupied columns. The value is an integer greater than 0. Default value: 1.

gridColOffset

gridColOffset(value: number|GridColColumnOption)

Sets the number of offset columns relative to the original position of the component.

Widget capability: This API can be used in ArkTS widgets since API version 9.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.ArkUI.ArkUI.Full

Parameters

Name	Type	Mandatory	Description
value	number \|GridColColumnOption	Yes	Number of offset columns relative to the previous child component of the grid The value is an integer greater than 0. Default value: 0.

order

order(value: number|GridColColumnOption)

Sets the sequence number of the component. Child components of the grid are sorted in ascending order based on their sequence numbers.

Widget capability: This API can be used in ArkTS widgets since API version 9.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.ArkUI.ArkUI.Full

Parameters

Name	Type	Mandatory	Description
value	number \|GridColColumnOption	Yes	Sequence number of the component. Child components of the grid are sorted in ascending order based on their sequence numbers. The value is an integer greater than 0. Default value: 0.

GridColColumnOption

Describes the numbers of grid columns occupied by the GridCol component on devices with different width types.

Widget capability: This API can be used in ArkTS widgets since API version 9.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.ArkUI.ArkUI.Full

Name	Type	Mandatory	Description
xs	number	No	Number of grid columns on the device where the grid size is xs.
sm	number	No	Number of grid columns on the device where the grid size is sm.
md	number	No	Number of grid columns on the device where the grid size is md.
lg	number	No	Number of grid columns on the device where the grid size is lg.
xl	number	No	Number of grid columns on the device where the grid size is xl.
xxl	number	No	Number of grid columns on the device where the grid size is xxl.