Skip to content

Commit

Permalink
docs(Grid): row Props.gutterTS类型补充lg,xl,xxl
Browse files Browse the repository at this point in the history
  • Loading branch information
liweijie0812 committed Jul 17, 2023
1 parent 65add56 commit 89451d0
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 8 deletions.
1 change: 0 additions & 1 deletion src/grid/col-props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ export default {
/** 栅格占位格数,为 0 时相当于 display: none */
span: {
type: Number,
default: 12,
},
/** 自定义元素标签 */
tag: {
Expand Down
6 changes: 3 additions & 3 deletions src/grid/grid.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

name | type | default | description | required
-- | -- | -- | -- | --
align | String | top | optionsstart/end/center/stretch/baseline/top/middle/bottom | N
gutter | Number / Object / Array | 0 | Typescript:`number \| GutterObject \| Array<GutterObject \| number>` `interface GutterObject { xs: number; sm: number; md: number } `[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/grid/type.ts) | N
justify | String | start | optionsstart/end/center/space-around/space-between | N
align | String | top | options: start/end/center/stretch/baseline/top/middle/bottom | N
gutter | Number / Object / Array | 0 | Typescript:`number \| GutterObject \| Array<GutterObject \| number>` `interface GutterObject { xs: number; sm: number; md: number; lg: number, xl: number; xxl: number; } `[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/grid/type.ts) | N
justify | String | start | options: start/end/center/space-around/space-between | N
tag | String | div | \- | N

### Col Props
Expand Down
2 changes: 1 addition & 1 deletion src/grid/grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
align | String | top | 纵向对齐方式,CSS 属性 `align-items` 值。其中 `top``start` 等效;`middle``center` 等效;`bottom``end` 等效。可选项:start/end/center/stretch/baseline/top/middle/bottom | N
gutter | Number / Object / Array | 0 | 栅格间隔,示例:`{ xs: 8, sm: 16, md: 24}`。当数据类型为 Number 和 Object 时,用于指定横向间隔。当数据类型为数组时,第一个参数为横向间隔,第二个参数为纵向间隔, [水平间隔, 垂直间隔]。TS 类型:`number \| GutterObject \| Array<GutterObject \| number>` `interface GutterObject { xs: number; sm: number; md: number } `[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/grid/type.ts) | N
gutter | Number / Object / Array | 0 | 栅格间隔,示例:`{ xs: 8, sm: 16, md: 24, lg: 32, xl: 32, xxl: 40 }`。当数据类型为 Number 和 Object 时,用于指定横向间隔。当数据类型为数组时,第一个参数为横向间隔,第二个参数为纵向间隔, [水平间隔, 垂直间隔]。TS 类型:`number \| GutterObject \| Array<GutterObject \| number>` `interface GutterObject { xs: number; sm: number; md: number; lg: number, xl: number; xxl: number; } `[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/grid/type.ts) | N
justify | String | start | flex 布局下的水平排列方式。可选项:start/end/center/space-around/space-between | N
tag | String | div | 自定义元素标签 | N

Expand Down
2 changes: 1 addition & 1 deletion src/grid/row-props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export default {
return ['start', 'end', 'center', 'stretch', 'baseline', 'top', 'middle', 'bottom'].includes(val);
},
},
/** 栅格间隔,示例:`{ xs: 8, sm: 16, md: 24}`。当数据类型为 Number 和 Object 时,用于指定横向间隔。当数据类型为数组时,第一个参数为横向间隔,第二个参数为纵向间隔, [水平间隔, 垂直间隔] */
/** 栅格间隔,示例:`{ xs: 8, sm: 16, md: 24, lg: 32, xl: 32, xxl: 40 }`。当数据类型为 Number 和 Object 时,用于指定横向间隔。当数据类型为数组时,第一个参数为横向间隔,第二个参数为纵向间隔, [水平间隔, 垂直间隔] */
gutter: {
type: [Number, Object, Array] as PropType<TdRowProps['gutter']>,
default: 0,
Expand Down
6 changes: 4 additions & 2 deletions src/grid/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export interface TdRowProps {
*/
align?: 'start' | 'end' | 'center' | 'stretch' | 'baseline' | 'top' | 'middle' | 'bottom';
/**
* 栅格间隔,示例:`{ xs: 8, sm: 16, md: 24}`。当数据类型为 Number 和 Object 时,用于指定横向间隔。当数据类型为数组时,第一个参数为横向间隔,第二个参数为纵向间隔, [水平间隔, 垂直间隔]
* 栅格间隔,示例:`{ xs: 8, sm: 16, md: 24, lg: 32, xl: 32, xxl: 40 }`。当数据类型为 Number 和 Object 时,用于指定横向间隔。当数据类型为数组时,第一个参数为横向间隔,第二个参数为纵向间隔, [水平间隔, 垂直间隔]
* @default 0
*/
gutter?: number | GutterObject | Array<GutterObject | number>;
Expand Down Expand Up @@ -66,7 +66,6 @@ export interface TdColProps {
sm?: number | BaseColProps;
/**
* 栅格占位格数,为 0 时相当于 display: none
* @default 12
*/
span?: number;
/**
Expand All @@ -92,6 +91,9 @@ export interface GutterObject {
xs: number;
sm: number;
md: number;
lg: number;
xl: number;
xxl: number;
}

export interface BaseColProps {
Expand Down

0 comments on commit 89451d0

Please sign in to comment.