mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-05-16 19:59:14 +08:00
149 lines
3.7 KiB
Markdown
149 lines
3.7 KiB
Markdown
# Grid
|
|
|
|
### Install
|
|
|
|
```js
|
|
import { createApp } from 'vue';
|
|
import { Grid, GridItem } from 'vant';
|
|
|
|
const app = createApp();
|
|
app.use(Grid);
|
|
app.use(GridItem);
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Basic Usage
|
|
|
|
```html
|
|
<van-grid>
|
|
<van-grid-item icon="photo-o" text="Text" />
|
|
<van-grid-item icon="photo-o" text="Text" />
|
|
<van-grid-item icon="photo-o" text="Text" />
|
|
<van-grid-item icon="photo-o" text="Text" />
|
|
</van-grid>
|
|
```
|
|
|
|
### Column Num
|
|
|
|
```html
|
|
<van-grid :column-num="3">
|
|
<van-grid-item v-for="value in 6" :key="value" icon="photo-o" text="Text" />
|
|
</van-grid>
|
|
```
|
|
|
|
### Custom Content
|
|
|
|
```html
|
|
<van-grid :border="false" :column-num="3">
|
|
<van-grid-item>
|
|
<van-image src="https://img01.yzcdn.cn/vant/apple-1.jpg" />
|
|
</van-grid-item>
|
|
<van-grid-item>
|
|
<van-image src="https://img01.yzcdn.cn/vant/apple-2.jpg" />
|
|
</van-grid-item>
|
|
<van-grid-item>
|
|
<van-image src="https://img01.yzcdn.cn/vant/apple-3.jpg" />
|
|
</van-grid-item>
|
|
</van-grid>
|
|
```
|
|
|
|
### Square
|
|
|
|
```html
|
|
<van-grid square>
|
|
<van-grid-item v-for="value in 8" :key="value" icon="photo-o" text="Text" />
|
|
</van-grid>
|
|
```
|
|
|
|
### Gutter
|
|
|
|
```html
|
|
<van-grid :gutter="10">
|
|
<van-grid-item v-for="value in 8" :key="value" icon="photo-o" text="Text" />
|
|
</van-grid>
|
|
```
|
|
|
|
### Horizontal
|
|
|
|
```html
|
|
<van-grid direction="horizontal" :column-num="2">
|
|
<van-grid-item icon="photo-o" text="文字" />
|
|
<van-grid-item icon="photo-o" text="文字" />
|
|
<van-grid-item icon="photo-o" text="文字" />
|
|
</van-grid>
|
|
```
|
|
|
|
### Route
|
|
|
|
```html
|
|
<van-grid clickable :column-num="2">
|
|
<van-grid-item icon="home-o" text="Vue Router" to="/" />
|
|
<van-grid-item icon="search" text="URL" url="/vant/mobile.html" />
|
|
</van-grid>
|
|
```
|
|
|
|
### Show Badge
|
|
|
|
```html
|
|
<van-grid :column-num="2">
|
|
<van-grid-item icon="home-o" text="Text" dot />
|
|
<van-grid-item icon="search" text="Text" badge="99+" />
|
|
</van-grid>
|
|
```
|
|
|
|
## API
|
|
|
|
### Grid Props
|
|
|
|
| Attribute | Description | Type | Default |
|
|
| --- | --- | --- | --- |
|
|
| column-num | Column Num | _number \| string_ | `4` |
|
|
| icon-size | Icon size | _number \| string_ | `28px` |
|
|
| gutter | Gutter | _number \| string_ | `0` |
|
|
| border | Whether to show border | _boolean_ | `true` |
|
|
| center | Whether to center content | _boolean_ | `true` |
|
|
| square | Whether to be square shape | _boolean_ | `false` |
|
|
| clickable | Whether to show click feedback when clicked | _boolean_ | `false` |
|
|
| direction | Content arrangement direction, can be set to `horizontal` | _string_ | `vertical` |
|
|
|
|
### GridItem Props
|
|
|
|
| Attribute | Description | Type | Default |
|
|
| --- | --- | --- | --- |
|
|
| text | Text | _string_ | - |
|
|
| icon | Icon name or URL | _string_ | - |
|
|
| icon-prefix | Icon className prefix | _string_ | `van-icon` |
|
|
| dot | Whether to show red dot | _boolean_ | `false` |
|
|
| badge | Content of the badge | _number \| string_ | - |
|
|
| url | Link URL | _string_ | - |
|
|
| to | Target route of the link, same as to of vue-router | _string \| object_ | - |
|
|
| replace | If true, the navigation will not leave a history record | _boolean_ | `false` |
|
|
|
|
### GridItem Events
|
|
|
|
| Event | Description | Arguments |
|
|
| ----- | --------------------------------- | ------------------- |
|
|
| click | Emitted when component is clicked | _event: MouseEvent_ |
|
|
|
|
### GridItem Slots
|
|
|
|
| Name | Description |
|
|
| ------- | -------------- |
|
|
| default | Custom content |
|
|
| icon | Custom icon |
|
|
| text | Custom text |
|
|
|
|
### Less Variables
|
|
|
|
How to use: [Custom Theme](#/en-US/theme).
|
|
|
|
| Name | Default Value | Description |
|
|
| --- | --- | --- |
|
|
| @grid-item-content-padding | `@padding-md @padding-xs` | - |
|
|
| @grid-item-content-background-color | `@white` | - |
|
|
| @grid-item-content-active-color | `@active-color` | - |
|
|
| @grid-item-icon-size | `28px` | - |
|
|
| @grid-item-text-color | `@gray-7` | - |
|
|
| @grid-item-text-font-size | `@font-size-sm` | - |
|