# grid-container

> phone | 2in1 | tablet | tv | wearable | lite_wearable

> 说明
>
> 从API version 5开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

栅格布局容器根节点，使用grid-row与grid-col进行栅格布局。

## 权限列表

> phone | 2in1 | tablet | tv | wearable | lite_wearable

无

## 子组件

> phone | 2in1 | tablet | tv | wearable | lite_wearable

仅支持<grid-row>。

## 属性

> phone | 2in1 | tablet | tv | wearable | lite_wearable

除支持[通用属性](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-components-common-attributes)外，还支持如下属性：

|名称|类型|默认值|必填|描述|
|:---------------|:--------------|:------|:-|:--------------------------------------------------------------------------------------------------------|
|columns|string | number|auto|否|设置当前布局总列数，使用string类型时仅支持auto，配置为auto时按照当前的sizetype决定总列数： - xs：2列。 - sm：4列。 - md：8列。 - lg：12列。|
|sizetype|string|auto|否|设置当前栅格使用的响应尺寸类型，支持xs, sm, md, lg类型，使用auto时按照当前容器大小自动选择xs, sm, md, lg类型。|
|gutter|<length>|24px|否|设置Gutter宽度。|
|gridtemplate^6+^|string|default|否|当设置了columns和sizetype属性为auto时，可以设置栅格容器的布局模板，通过布局模板设置不同响应尺寸下的Columns、Gutters和Margins，详见表 gridtemplate可选值说明。|

**表1** gridtemplate可选值说明^6+^

|名称|模板值|可响应的**栅格断点系统**|Columns|Margins(px)|Gutters(px)|
|:-----|:------|:------------------|:------|:----------|:----------|
|默认栅格|default|xs|2|12|12|
|默认栅格|default|sm|4|24|24|
|默认栅格|default|md|8|32|24|
|默认栅格|default|lg|12|48|24|
|宫格布局栅格|grid|sm(0<设备水平分辨率<600px)|4|24|12|
|宫格布局栅格|grid|md|8|32|12|
|宫格布局栅格|grid|lg|12|48|12|

> 说明
>
> 本章中px单位是在js标签中配置了autoDesignWidth为true。^6+^

## 样式

> phone | 2in1 | tablet | tv | wearable | lite_wearable

除支持[通用样式](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-components-common-styles)外，还支持如下样式：

|名称|类型|默认值|必填|描述|
|:--------------|:-----|:---------|:-|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|justify-content|string|flex-start|否|flex容器当前行的主轴对齐格式，可选项有： - flex-start：项目位于容器的开头。 - flex-end：项目位于容器的结尾。 - center：项目位于容器的中心。 - space-between：项目位于各行之间留有空白的容器内。 - space-around：项目位于各行之前、之间、之后都留有空白的容器内。|
|align-items|string|stretch|否|flex容器当前行的交叉轴对齐格式，可选值为： - stretch：弹性元素在交叉轴方向被拉伸到与容器相同的高度或宽度。 - flex-start：元素向交叉轴起点对齐。 - flex-end：元素向交叉轴终点对齐。 - center：元素在交叉轴居中。|
|align-content|string|flex-start|否|交叉轴中有额外的空间时，多行内容对齐格式，可选值为： - flex-start：所有行从交叉轴起点开始填充。第一行的交叉轴起点边和容器的交叉轴起点边对齐。接下来的每一行紧跟前一行。 - flex-end：所有行从交叉轴末尾开始填充。最后一行的交叉轴终点和容器的交叉轴终点对齐。同时所有后续行与前一个对齐。 - center：所有行朝向容器的中心填充。每行互相紧挨，相对于容器居中对齐。容器的交叉轴起点边和第一行的距离相等于容器的交叉轴终点边和最后一行的距离。 - space-between：所有行在容器中平均分布。相邻两行间距相等。容器的交叉轴起点边和终点边分别与第一行和最后一行的边对齐。 - space-around：所有行在容器中平均分布，相邻两行间距相等。容器的交叉轴起点边和终点边分别与第一行和最后一行的距离是相邻两行间距的一半。|

## 事件

> phone | 2in1 | tablet | tv | wearable | lite_wearable

支持[通用事件](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-components-common-events)。

## 方法

> phone | 2in1 | tablet | tv | wearable | lite_wearable

除支持[通用方法](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-components-common-methods)外，还支持如下方法：

|名称|参数|描述|
|:-------------|:-----------------------|:----------------------------------------------|
|getColumns|(result: number) => void|获取栅格容器列数。result表示获取到的栅格容器列数。|
|getColumnWidth|(result: number) => void|获取栅格容器column宽度。result表示获取到的栅格容器column宽度。|
|getGutterWidth|(result: number) => void|获取栅格容器gutter宽度。result表示获取到的栅格容器gutter宽度。|
|getSizeType|(result: number) => void|获取当前容器响应尺寸类型（xs|sm|md|lg）。result表示获取到的容器响应尺寸类型。|

## 示例

> phone | 2in1 | tablet | tv | wearable | lite_wearable

详见[grid-col示例](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-components-grid-col#示例)。