• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Flex布局
2<!--Kit: ArkUI-->
3<!--Subsystem: ArkUI-->
4<!--Owner: @camlostshi-->
5<!--Designer: @lanshouren-->
6<!--Tester: @liuli0427-->
7<!--Adviser: @HelloCrease-->
8
9>  **说明:**
10>  - 从API version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
11>
12>  - 仅当父组件是 [Flex](ts-container-flex.md)、[Column](ts-container-column.md)、[Row](ts-container-row.md)或[GridRow](ts-container-gridrow.md)(仅针对[alignSelf](#alignself))时生效。
13
14## flexBasis
15
16flexBasis(value: number | string): T
17
18设置组件的基准尺寸。
19
20**卡片能力:** 从API version 9开始,该接口支持在ArkTS卡片中使用。
21
22**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
23
24**系统能力:** SystemCapability.ArkUI.ArkUI.Full
25
26**参数:**
27
28| 参数名 | 类型                       | 必填 | 说明                                                         |
29| ------ | -------------------------- | ---- | ------------------------------------------------------------ |
30| value  | number&nbsp;\|&nbsp;string | 是   | 设置组件在父容器主轴方向上的基准尺寸。<br/>默认值:'auto'(表示组件在主轴方向上的基准尺寸为组件原本的大小)。<br/>string类型可选值:可以转化为数字的字符串(如'10')或带长度单位的字符串(如'10px')或'auto',不允许设置百分比字符串。<br/>number:取值范围(0,+∞),单位为vp。<br/>异常值:默认为'auto'。 |
31
32**返回值:**
33
34| 类型 | 说明 |
35| --- | --- |
36|  T | 返回当前组件。 |
37
38## flexGrow
39
40flexGrow(value: number): T
41
42设置组件在父容器的剩余空间所占比例。
43
44**卡片能力:** 从API version 9开始,该接口支持在ArkTS卡片中使用。
45
46**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
47
48**系统能力:** SystemCapability.ArkUI.ArkUI.Full
49
50**参数:**
51
52| 参数名 | 类型   | 必填 | 说明                                                         |
53| ------ | ------ | ---- | ------------------------------------------------------------ |
54| value  | number | 是   | 设置父容器在主轴方向上的剩余空间分配给此属性所在组件的比例。<br/>取值范围[0,+∞),默认值:0 |
55
56**返回值:**
57
58| 类型 | 说明 |
59| --- | --- |
60|  T | 返回当前组件。 |
61
62## flexShrink
63
64flexShrink(value: number): T
65
66设置父容器压缩尺寸分配给此属性所在组件的比例。当父容器为Column、Row时,需设置主轴方向的尺寸。
67
68**卡片能力:** 从API version 9开始,该接口支持在ArkTS卡片中使用。
69
70**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
71
72**系统能力:** SystemCapability.ArkUI.ArkUI.Full
73
74**参数:**
75
76| 参数名 | 类型   | 必填 | 说明                                                         |
77| ------ | ------ | ---- | ------------------------------------------------------------ |
78| value  | number | 是   | 设置父容器压缩尺寸分配给此属性所在组件的比例。<br/>父容器为[Column](ts-container-column.md)、[Row](ts-container-row.md)时,默认值:0,取值范围[0,+∞)。<br/> 父容器为[Flex](ts-container-flex.md)时,默认值:1 <br/>[constraintSize](ts-universal-attributes-size.md#constraintsize)限制组件的尺寸范围。[Column](ts-container-column.md)和[Row](ts-container-row.md)即使设置了[constraintSize](ts-universal-attributes-size.md#constraintsize),在未设置主轴尺寸([width](ts-universal-attributes-size.md#width)/[height](ts-universal-attributes-size.md#height)/[size](ts-universal-attributes-size.md#size))时仍遵守默认布局行为,在主轴上自适应子组件尺寸,此时flexShrink不生效。|
79
80**返回值:**
81
82| 类型 | 说明 |
83| --- | --- |
84|  T | 返回当前组件。 |
85
86## alignSelf
87
88alignSelf(value: ItemAlign): T
89
90子组件在父容器交叉轴的对齐格式。
91
92**卡片能力:** 从API version 9开始,该接口支持在ArkTS卡片中使用。
93
94**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
95
96**系统能力:** SystemCapability.ArkUI.ArkUI.Full
97
98**参数:**
99
100| 参数名 | 类型                                        | 必填 | 说明                                                         |
101| ------ | ------------------------------------------- | ---- | ------------------------------------------------------------ |
102| value  | [ItemAlign](ts-appendix-enums.md#itemalign) | 是   | 子组件在父容器交叉轴的对齐格式,会覆盖[Flex](ts-container-flex.md)、[Column](ts-container-column.md)、[Row](ts-container-row.md)、[GridRow](ts-container-gridrow.md)布局容器中的alignItems设置。<br/>[GridCol](./ts-container-gridcol.md)可以绑定alignSelf属性来改变它自身在交叉轴方向上的布局。<br/>默认值:ItemAlign.Auto |
103
104**返回值:**
105
106| 类型 | 说明 |
107| --- | --- |
108|  T | 返回当前组件。 |
109
110## 示例
111
112通过配置flexBasis/flexGrow/flexShrink/alignSelf属性设置Flex布局。
113
114```ts
115// xxx.ets
116@Entry
117@Component
118struct FlexExample {
119  build() {
120    Column({ space: 5 }) {
121      Text('flexBasis').fontSize(9).fontColor(0xCCCCCC).width('90%')
122      // 基于主轴的基准尺寸
123      // flexBasis()值可以是字符串'auto',表示基准尺寸是元素本来的大小,也可以是长度设置,相当于.width()/.height()
124      Flex() {
125        Text('flexBasis(100)')
126          .flexBasis(100) // 这里表示宽度为100vp
127          .height(100)
128          .backgroundColor(0xF5DEB3)
129          .textAlign(TextAlign.Center)
130        Text(`flexBasis('auto')`)
131          .flexBasis('auto') // 这里表示宽度保持原本设置的60%的宽度
132          .width('60%')
133          .height(100)
134          .backgroundColor(0xD2B48C)
135          .textAlign(TextAlign.Center)
136      }.width('90%').height(120).padding(10).backgroundColor(0xAFEEEE)
137
138      Text('flexGrow').fontSize(9).fontColor(0xCCCCCC).width('90%')
139      // flexGrow()表示剩余空间分配给该元素的比例
140      Flex() {
141        Text('flexGrow(2)')
142          .flexGrow(2) // 父容器分配给该Text的宽度为剩余宽度的2/3
143          .height(100)
144          .backgroundColor(0xF5DEB3)
145          .textAlign(TextAlign.Center)
146        Text('flexGrow(1)')
147          .flexGrow(1) // 父容器分配给该Text的宽度为剩余宽度的1/3
148          .height(100)
149          .backgroundColor(0xD2B48C)
150          .textAlign(TextAlign.Center)
151      }.width('90%').height(120).padding(10).backgroundColor(0xAFEEEE)
152
153      Text('flexShrink').fontSize(9).fontColor(0xCCCCCC).width('90%')
154      // flexShrink()表示该元素的压缩比例,基于超出的总尺寸进行计算
155      // 第一个text压缩比例是0,另外两个都是1,因此放不下时等比例压缩后两个,第一个不压缩
156      Flex({ direction: FlexDirection.Row }) {
157        Text('flexShrink(0)')
158          .flexShrink(0)
159          .width('50%')
160          .height(100)
161          .backgroundColor(0xF5DEB3)
162          .textAlign(TextAlign.Center)
163        Text('default flexShrink') // 默认值为1
164          .width('40%')
165          .height(100)
166          .backgroundColor(0xD2B48C)
167          .textAlign(TextAlign.Center)
168        Text('flexShrink(1)')
169          .flexShrink(1)
170          .width('40%')
171          .height(100)
172          .backgroundColor(0xF5DEB3)
173          .textAlign(TextAlign.Center)
174      }.width('90%').height(120).padding(10).backgroundColor(0xAFEEEE)
175
176      Text('alignSelf').fontSize(9).fontColor(0xCCCCCC).width('90%')
177      // alignSelf会覆盖Flex布局容器中的alignItems设置
178      Flex({ direction: FlexDirection.Row, alignItems: ItemAlign.Center }) {
179        Text('no alignSelf,height:70')
180          .width('33%')
181          .height(70)
182          .backgroundColor(0xF5DEB3)
183          .textAlign(TextAlign.Center)
184        Text('alignSelf End')
185          .alignSelf(ItemAlign.End)
186          .width('33%')
187          .height(70)
188          .backgroundColor(0xD2B48C)
189          .textAlign(TextAlign.Center)
190        Text('no alignSelf,height:100%')
191          .width('34%')
192          .height('100%')
193          .backgroundColor(0xF5DEB3)
194          .textAlign(TextAlign.Center)
195      }.width('90%').height(120).padding(10).backgroundColor(0xAFEEEE)
196    }.width('100%').margin({ top: 5 })
197  }
198}
199```
200
201![flex](figures/flex.PNG)
202