5.9 KiB
5.9 KiB
title, description, spline, isComponent
| title | description | spline | isComponent |
|---|---|---|---|
| Grid 宫格 | 用于功能入口布局,将页面或特定区域切分成若干等大的区块,形成若干功能入口。 | data | true |
引入
全局引入,在 miniprogram 根目录下的app.json中配置,局部引入,在需要引入的页面或组件的index.json中配置。
"usingComponents": {
"t-grid": "tdesign-miniprogram/grid/grid",
"t-grid-item": "tdesign-miniprogram/grid-item/grid-item"
}
代码演示
Tips: 请确保开发者工具为打开状态。导入开发者工具后,依次执行:npm i > 构建npm包 > 勾选 "将JS编译成ES5"
组件类型
基础宫格
{{ base }}
带说明的宫格
{{ description }}
带边框的宫格
{{ border }}
带徽章的宫格
{{ badge }}
可滑动的宫格
{{ scroll }}
组件样式
可传图标的宫格
{{ icon-grid }}
多行宫格
{{ multiple }}
卡片宫格
{{ card }}
API
Grid Props
| 名称 | 类型 | 默认值 | 描述 | 必传 |
|---|---|---|---|---|
| style | Object | - | 样式 | N |
| custom-style | Object | - | 样式,一般用于开启虚拟化组件节点场景 | N |
| align | String | center | 内容对齐方式。可选项:left/center | N |
| border | Boolean / Object | false | 边框,默认不显示。值为 true 则显示默认边框,值类型为 object 则表示自定义边框样式。TS 类型:boolean | { color?: string; width?: string; style?: 'solid' | 'dashed' | 'dotted' | 'double' | 'groove' | 'inset' | 'outset' } |
N |
| column | Number | 4 | 每一行的列数量;为 0 时等于固定大小 | N |
| gutter | Number | - | 间隔大小 | N |
| hover | Boolean | false | 是否开启点击反馈 | N |
| theme | String | default | 宫格的风格。可选项:default/card | N |
Grid External Classes
| 类名 | 描述 |
|---|---|
| t-class | 根节点样式类 |
GridItem Props
| 名称 | 类型 | 默认值 | 描述 | 必传 |
|---|---|---|---|---|
| style | Object | - | 样式 | N |
| custom-style | Object | - | 样式,一般用于开启虚拟化组件节点场景 | N |
| badge-props | Object | null | 透传至 Badge 属性。TS 类型:BadgeProps,Badge API Documents。详细类型定义 |
N |
| description | String / Slot | - | 文本以外的更多描述,辅助信息。可以通过 Props 传入文本,也可以自定义标题节点。通用类型定义 | N |
| icon | String / Object | - | 图标名称。值为字符串表示图标名称,值为 Object 类型,表示透传至 icon |
N |
| image | String / Slot | - | 图片,可以是图片地址,也可以自定义图片节点,值为 slot 的时候才能使用插槽。通用类型定义 | N |
| image-props | Object | - | 透传至 Image 组件。TS 类型:ImageProps,Image API Documents。详细类型定义 |
N |
| jump-type | String | navigate-to | 链接跳转类型。可选项:redirect-to/switch-tab/relaunch/navigate-to | N |
| layout | String | vertical | 内容布局方式。可选项:vertical/horizontal | N |
| text | String / Slot | - | 文本,可以通过 Props 传入文本,也可以自定义标题节点。通用类型定义 | N |
| url | String | - | 点击后的跳转链接 | N |
GridItem Events
| 名称 | 参数 | 描述 |
|---|---|---|
| click | - | 点击子项后触发。通用类型定义 |
GridItem External Classes
| 类名 | 描述 |
|---|---|
| t-class | 根节点样式类 |
| t-class-content | 内容样式类 |
| t-class-description | 描述样式类 |
| t-class-image | 图片样式类 |
| t-class-text | 文本样式类 |
CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
| 名称 | 默认值 | 描述 |
|---|---|---|
| --td-grid-bg-color | @bg-color-container | - |
| --td-grid-card-radius | @radius-large | - |
| --td-grid-item-bg-color | @bg-color-container | - |
| --td-grid-item-description-color | @font-gray-3 | - |
| --td-grid-item-description-font-size | 24rpx | - |
| --td-grid-item-description-line-height | 40rpx | - |
| --td-grid-item-description-padding-top | 8rpx | - |
| --td-grid-item-horizontal-text-description-top | 4rpx | - |
| --td-grid-item-horizontal-text-padding-left | 24rpx | - |
| --td-grid-item-hover-bg-color | @bg-color-secondarycontainer | - |
| --td-grid-item-image-middle-width | 80rpx | - |
| --td-grid-item-image-small-width | 64rpx | - |
| --td-grid-item-image-width | 96rpx | - |
| --td-grid-item-padding | 32rpx | - |
| --td-grid-item-text-color | @font-gray-1 | - |
| --td-grid-item-text-font-size | 28rpx | - |
| --td-grid-item-text-line-height | 44rpx | - |
| --td-grid-item-text-middle-font-size | 24rpx | - |
| --td-grid-item-text-padding-top | 16rpx | - |
| --td-grid-item-text-small-font-size | 24rpx | - |