add file
This commit is contained in:
haomingming
@@ -0,0 +1,31 @@
|
||||
:: BASE_DOC ::
|
||||
|
||||
## API
|
||||
### Grid Props
|
||||
|
||||
name | type | default | description | required
|
||||
-- | -- | -- | -- | --
|
||||
align | String | center | options：left/center | N
|
||||
border | Boolean / Object | false | Typescript：`boolean \| { color?: string; width?: string; style?: 'solid' \| 'dashed' \| 'dotted' \| 'double' \| 'groove' \| 'inset' \| 'outset' }` | N
|
||||
column | Number | 4 | \- | N
|
||||
custom-style | String | - | \- | N
|
||||
external-classes | Array | - | `['t-class']` | N
|
||||
gutter | Number | - | \- | N
|
||||
hover | Boolean | false | \- | N
|
||||
theme | String | default | options：default/card | N
|
||||
|
||||
### GridItem Props
|
||||
|
||||
name | type | default | description | required
|
||||
-- | -- | -- | -- | --
|
||||
badge-props | Object | null | Typescript：`BadgeProps`，[Badge API Documents](./badge?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/grid-item/type.ts) | N
|
||||
custom-style | String | - | \- | N
|
||||
description | String / Slot | - | \- | N
|
||||
external-classes | Array | - | `['t-class', 't-class-image', 't-class-text', 't-class-description']` | N
|
||||
icon | String / Object | - | \- | N
|
||||
image | String / Slot | - | \- | N
|
||||
image-props | Object | - | \- | N
|
||||
jump-type | String | navigate-to | options：redirect-to/switch-tab/relaunch/navigate-to | N
|
||||
layout | String | vertical | options：vertical/horizontal | N
|
||||
text | String / Slot | - | \- | N
|
||||
url | String | - | \- | N
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
title: Grid 宫格
|
||||
description: 用于功能入口布局，将页面或特定区域切分成若干等大的区块，形成若干功能入口。
|
||||
spline: data
|
||||
isComponent: true
|
||||
---
|
||||
|
||||
<span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20lines-97%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20functions-93%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20statements-97%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20branches-94%25-blue" /></span>
|
||||
## 引入
|
||||
|
||||
全局引入，在 miniprogram 根目录下的`app.json`中配置，局部引入，在需要引入的页面或组件的`index.json`中配置。
|
||||
|
||||
```json
|
||||
"usingComponents": {
|
||||
"t-grid": "tdesign-miniprogram/grid/grid",
|
||||
"t-grid-item": "tdesign-miniprogram/grid-item/grid-item"
|
||||
}
|
||||
```
|
||||
|
||||
## 代码演示
|
||||
|
||||
### 组件类型
|
||||
基础宫格
|
||||
|
||||
{{ base }}
|
||||
|
||||
带说明的宫格
|
||||
|
||||
{{ description }}
|
||||
|
||||
带边框的宫格
|
||||
|
||||
{{ border }}
|
||||
|
||||
带徽章的宫格
|
||||
|
||||
{{ badge }}
|
||||
|
||||
可滑动的宫格
|
||||
|
||||
{{ scroll }}
|
||||
|
||||
### 组件样式
|
||||
|
||||
可传图标的宫格
|
||||
|
||||
{{ icon-grid }}
|
||||
|
||||
多行宫格
|
||||
|
||||
{{ multiple }}
|
||||
|
||||
卡片宫格
|
||||
|
||||
{{ card }}
|
||||
|
||||
|
||||
## API
|
||||
### Grid Props
|
||||
|
||||
名称 | 类型 | 默认值 | 说明 | 必传
|
||||
-- | -- | -- | -- | --
|
||||
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
|
||||
custom-style | String | - | 自定义组件样式 | N
|
||||
external-classes | Array | - | 组件类名，用于设置组件外层元素类名。`['t-class']` | N
|
||||
gutter | Number | - | 间隔大小 | N
|
||||
hover | Boolean | false | 是否开启点击反馈 | N
|
||||
theme | String | default | 宫格的风格。可选项：default/card | N
|
||||
|
||||
### GridItem Props
|
||||
|
||||
名称 | 类型 | 默认值 | 说明 | 必传
|
||||
-- | -- | -- | -- | --
|
||||
badge-props | Object | null | 透传至 Badge 属性。TS 类型：`BadgeProps`，[Badge API Documents](./badge?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/grid-item/type.ts) | N
|
||||
custom-style | String | - | 自定义组件样式 | N
|
||||
description | String / Slot | - | 文本以外的更多描述，辅助信息。可以通过 Props 传入文本，也可以自定义标题节点 | N
|
||||
external-classes | Array | - | 组件类名，分别用于设置组件外层元素、图片、文本、描述等元素类名。`['t-class', 't-class-image', 't-class-text', 't-class-description']` | N
|
||||
icon | String / Object | - | 图标名称。值为字符串表示图标名称，值为 `Object` 类型，表示透传至 `icon` | N
|
||||
image | String / Slot | - | 图片，可以是图片地址，也可以自定义图片节点 | N
|
||||
image-props | Object | - | 透传至 Image 组件 | 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
|
||||
@@ -0,0 +1,23 @@
|
||||
import { SuperComponent, RelationsOptions } from '../common/src/index';
|
||||
export default class Grid extends SuperComponent {
|
||||
externalClasses: string[];
|
||||
relations: RelationsOptions;
|
||||
properties: import("./type").TdGridProps;
|
||||
data: {
|
||||
prefix: string;
|
||||
classPrefix: string;
|
||||
contentStyle: string;
|
||||
};
|
||||
observers: {
|
||||
'column,hover,align'(): void;
|
||||
'gutter,border'(): void;
|
||||
};
|
||||
lifetimes: {
|
||||
attached(): void;
|
||||
};
|
||||
methods: {
|
||||
doForChild(action: (item: WechatMiniprogram.Component.TrivialInstance) => void): void;
|
||||
updateContentStyle(): void;
|
||||
getContentMargin(): string;
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
||||
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
||||
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
||||
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
||||
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
||||
};
|
||||
import { isObject, SuperComponent, wxComponent } from '../common/src/index';
|
||||
import config from '../common/config';
|
||||
import props from './props';
|
||||
const { prefix } = config;
|
||||
const name = `${prefix}-grid`;
|
||||
let Grid = class Grid extends SuperComponent {
|
||||
constructor() {
|
||||
super(...arguments);
|
||||
this.externalClasses = ['t-class'];
|
||||
this.relations = {
|
||||
'../grid-item/grid-item': {
|
||||
type: 'descendant',
|
||||
},
|
||||
};
|
||||
this.properties = props;
|
||||
this.data = {
|
||||
prefix,
|
||||
classPrefix: name,
|
||||
contentStyle: '',
|
||||
};
|
||||
this.observers = {
|
||||
'column,hover,align'() {
|
||||
this.updateContentStyle();
|
||||
},
|
||||
'gutter,border'() {
|
||||
this.updateContentStyle();
|
||||
this.doForChild((child) => child.updateStyle());
|
||||
},
|
||||
};
|
||||
this.lifetimes = {
|
||||
attached() {
|
||||
this.updateContentStyle();
|
||||
},
|
||||
};
|
||||
this.methods = {
|
||||
doForChild(action) {
|
||||
this.$children.forEach(action);
|
||||
},
|
||||
updateContentStyle() {
|
||||
const contentStyles = [];
|
||||
const marginStyle = this.getContentMargin();
|
||||
marginStyle && contentStyles.push(marginStyle);
|
||||
this.setData({
|
||||
contentStyle: contentStyles.join(';'),
|
||||
});
|
||||
},
|
||||
getContentMargin() {
|
||||
const { gutter } = this.properties;
|
||||
let { border } = this.properties;
|
||||
if (!border)
|
||||
return `margin-left:-${gutter}rpx; margin-top:-${gutter}rpx`;
|
||||
if (!isObject(border))
|
||||
border = {};
|
||||
const { width = 2 } = border;
|
||||
return `margin-left:-${width}rpx; margin-top:-${width}rpx`;
|
||||
},
|
||||
};
|
||||
}
|
||||
};
|
||||
Grid = __decorate([
|
||||
wxComponent()
|
||||
], Grid);
|
||||
export default Grid;
|
||||
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"component": true,
|
||||
"usingComponents": {}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
<wxs src="../common/utils.wxs" module="_" />
|
||||
|
||||
<view style="{{ customStyle }}" class="{{_.cls(classPrefix, [theme])}} {{prefix}}-class">
|
||||
<view wx:if="{{column > 0}}" class="{{classPrefix}}__content" style="{{ contentStyle }}">
|
||||
<slot />
|
||||
</view>
|
||||
<scroll-view
|
||||
wx:else
|
||||
scroll-x
|
||||
scroll-with-animation
|
||||
class="{{classPrefix}}__content"
|
||||
style="{{ 'white-space: nowrap;' + contentStyle }}"
|
||||
>
|
||||
<slot />
|
||||
</scroll-view>
|
||||
</view>
|
||||
@@ -0,0 +1,40 @@
|
||||
.t-float-left {
|
||||
float: left;
|
||||
}
|
||||
.t-float-right {
|
||||
float: right;
|
||||
}
|
||||
@keyframes tdesign-fade-out {
|
||||
from {
|
||||
opacity: 1;
|
||||
}
|
||||
to {
|
||||
opacity: 0;
|
||||
}
|
||||
}
|
||||
.hotspot-expanded.relative {
|
||||
position: relative;
|
||||
}
|
||||
.hotspot-expanded::after {
|
||||
content: '';
|
||||
display: block;
|
||||
position: absolute;
|
||||
left: 0;
|
||||
top: 0;
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
transform: scale(1.5);
|
||||
}
|
||||
.t-grid {
|
||||
position: relative;
|
||||
overflow: hidden;
|
||||
background-color: var(--td-grid-bg-color, var(--td-bg-color-block, #fff));
|
||||
}
|
||||
.t-grid__content {
|
||||
width: auto;
|
||||
}
|
||||
.t-grid--card {
|
||||
margin: 0 32rpx;
|
||||
border-radius: var(--td-grid-card-radius, var(--td-radius-large, 18rpx));
|
||||
overflow: hidden;
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
import { TdGridProps } from './type';
|
||||
declare const props: TdGridProps;
|
||||
export default props;
|
||||
@@ -0,0 +1,33 @@
|
||||
const props = {
|
||||
align: {
|
||||
type: String,
|
||||
value: 'center',
|
||||
},
|
||||
border: {
|
||||
type: null,
|
||||
value: false,
|
||||
},
|
||||
column: {
|
||||
type: Number,
|
||||
value: 4,
|
||||
},
|
||||
customStyle: {
|
||||
type: String,
|
||||
value: '',
|
||||
},
|
||||
externalClasses: {
|
||||
type: Array,
|
||||
},
|
||||
gutter: {
|
||||
type: Number,
|
||||
},
|
||||
hover: {
|
||||
type: Boolean,
|
||||
value: false,
|
||||
},
|
||||
theme: {
|
||||
type: String,
|
||||
value: 'default',
|
||||
},
|
||||
};
|
||||
export default props;
|
||||
@@ -0,0 +1,38 @@
|
||||
export interface TdGridProps {
|
||||
align?: {
|
||||
type: StringConstructor;
|
||||
value?: 'left' | 'center';
|
||||
};
|
||||
border?: {
|
||||
type: null;
|
||||
value?: boolean | {
|
||||
color?: string;
|
||||
width?: string;
|
||||
style?: 'solid' | 'dashed' | 'dotted' | 'double' | 'groove' | 'inset' | 'outset';
|
||||
};
|
||||
};
|
||||
column?: {
|
||||
type: NumberConstructor;
|
||||
value?: number;
|
||||
};
|
||||
customStyle?: {
|
||||
type: StringConstructor;
|
||||
value?: string;
|
||||
};
|
||||
externalClasses?: {
|
||||
type: ArrayConstructor;
|
||||
value?: ['t-class'];
|
||||
};
|
||||
gutter?: {
|
||||
type: NumberConstructor;
|
||||
value?: number;
|
||||
};
|
||||
hover?: {
|
||||
type: BooleanConstructor;
|
||||
value?: boolean;
|
||||
};
|
||||
theme?: {
|
||||
type: StringConstructor;
|
||||
value?: 'default' | 'card';
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
export {};
|
||||
Reference in New Issue
Block a user