Skip to content

Commit

Permalink
Descriptions: add description component
Browse files Browse the repository at this point in the history
  • Loading branch information
cs1707 committed Jul 7, 2021
1 parent 68e07ca commit b339036
Show file tree
Hide file tree
Showing 23 changed files with 1,585 additions and 2 deletions.
4 changes: 3 additions & 1 deletion components.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,5 +83,7 @@
"popconfirm": "./packages/popconfirm/index.js",
"skeleton": "./packages/skeleton/index.js",
"skeleton-item": "./packages/skeleton-item/index.js",
"empty": "./packages/empty/index.js"
"empty": "./packages/empty/index.js",
"descriptions": "./packages/description/index.js",
"descriptions-item": "./packages/description-item/index.js"

This comment has been minimized.

Copy link
@wangdaodao

wangdaodao Jul 8, 2021

Contributor
 "descriptions": "./packages/descriptions/index.js",
  "descriptions-item": "./packages/descriptions-item/index.js"

拼错了,少了一个s

}
13 changes: 13 additions & 0 deletions examples/demo-styles/descriptions.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.demo-block.demo-descriptions {
.margin-top {
margin-top: 20px;
}

.my-label {
background: #E1F3D8;
}

.my-content {
background: #FDE2E2;
}
}
1 change: 1 addition & 0 deletions examples/demo-styles/index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,5 @@
@import "./avatar.scss";
@import "./drawer.scss";
@import "./skeleton.scss";
@import "./descriptions.scss";

191 changes: 191 additions & 0 deletions examples/docs/en-US/descriptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
## Descriptions

Display multiple fields in list form.

### Basic usage

:::demo

```html
<el-descriptions title="User Info">
<el-descriptions-item label="Username">kooriookami</el-descriptions-item>
<el-descriptions-item label="Telephone">18100000000</el-descriptions-item>
<el-descriptions-item label="Place">Suzhou</el-descriptions-item>
<el-descriptions-item label="Remarks">
<el-tag size="small">School</el-tag>
</el-descriptions-item>
<el-descriptions-item label="Address">No.1188, Wuzhong Avenue, Wuzhong District, Suzhou, Jiangsu Province</el-descriptions-item>
</el-descriptions>
```
:::

### Sizes

:::demo

```html
<template>
<el-radio-group v-model="size">
<el-radio label="">Default</el-radio>
<el-radio label="medium">Medium</el-radio>
<el-radio label="small">Small</el-radio>
<el-radio label="mini">Mini</el-radio>
</el-radio-group>

<el-descriptions class="margin-top" title="With border" :column="3" :size="size" border>
<template slot="extra">
<el-button type="primary" size="small">Operation</el-button>
</template>
<el-descriptions-item>
<template slot="label">
<i class="el-icon-user"></i>
Username
</template>
kooriookami
</el-descriptions-item>
<el-descriptions-item>
<template slot="label">
<i class="el-icon-mobile-phone"></i>
Telephone
</template>
18100000000
</el-descriptions-item>
<el-descriptions-item>
<template slot="label">
<i class="el-icon-location-outline"></i>
Place
</template>
Suzhou
</el-descriptions-item>
<el-descriptions-item>
<template slot="label">
<i class="el-icon-tickets"></i>
Remarks
</template>
<el-tag size="small">School</el-tag>
</el-descriptions-item>
<el-descriptions-item>
<template slot="label">
<i class="el-icon-office-building"></i>
Address
</template>
No.1188, Wuzhong Avenue, Wuzhong District, Suzhou, Jiangsu Province
</el-descriptions-item>
</el-descriptions>

<el-descriptions class="margin-top" title="Without border" :column="3" :size="size">
<template slot="extra">
<el-button type="primary" size="small">Operation</el-button>
</template>
<el-descriptions-item label="Username">kooriookami</el-descriptions-item>
<el-descriptions-item label="Telephone">18100000000</el-descriptions-item>
<el-descriptions-item label="Place">Suzhou</el-descriptions-item>
<el-descriptions-item label="Remarks">
<el-tag size="small">School</el-tag>
</el-descriptions-item>
<el-descriptions-item label="Address">No.1188, Wuzhong Avenue, Wuzhong District, Suzhou, Jiangsu Province</el-descriptions-item>
</el-descriptions>
</template>

<script>
export default {
data () {
return {
size: ''
};
}
}
</script>
```
:::

### Vertical List

:::demo

```html
<el-descriptions title="Vertical list with border" direction="vertical" :column="4" border>
<el-descriptions-item label="Username">kooriookami</el-descriptions-item>
<el-descriptions-item label="Telephone">18100000000</el-descriptions-item>
<el-descriptions-item label="Place" :span="2">Suzhou</el-descriptions-item>
<el-descriptions-item label="Remarks">
<el-tag size="small">School</el-tag>
</el-descriptions-item>
<el-descriptions-item label="Address">No.1188, Wuzhong Avenue, Wuzhong District, Suzhou, Jiangsu Province</el-descriptions-item>
</el-descriptions>

<el-descriptions class="margin-top" title="Vertical list without border" :column="4" direction="vertical">
<el-descriptions-item label="Username">kooriookami</el-descriptions-item>
<el-descriptions-item label="Telephone">18100000000</el-descriptions-item>
<el-descriptions-item label="Place" :span="2">Suzhou</el-descriptions-item>
<el-descriptions-item label="Remarks">
<el-tag size="small">School</el-tag>
</el-descriptions-item>
<el-descriptions-item label="Address">No.1188, Wuzhong Avenue, Wuzhong District, Suzhou, Jiangsu Province</el-descriptions-item>
</el-descriptions>
```
:::

### Customized Style

:::demo

```html
<el-descriptions title="Customized style list" :column="3" border>
<el-descriptions-item label="Username" label-class-name="my-label" content-class-name="my-content">kooriookami</el-descriptions-item>
<el-descriptions-item label="Telephone">18100000000</el-descriptions-item>
<el-descriptions-item label="Place">Suzhou</el-descriptions-item>
<el-descriptions-item label="Remarks">
<el-tag size="small">School</el-tag>
</el-descriptions-item>
<el-descriptions-item label="Address" :content-style="{'text-align': 'right'}">No.1188, Wuzhong Avenue, Wuzhong District, Suzhou, Jiangsu Province</el-descriptions-item>
</el-descriptions>
<style>
.my-label {
background: #E1F3D8;
}
.my-content {
background: #FDE2E2;
}
</style>
```
:::

### Descriptions Attributes
| Attribute | Description | Type | Accepted Values | Default |
|------------- |---------------- |---------------- |---------------------- |-------- |
| border | with or without border | boolean || false |
| column | numbers of `Descriptions Item` in one line | number || 3 |
| direction | direction of list | string | vertical / horizontal | horizontal |
| size | size of list | string | medium / small / mini ||
| title | title text, display on the top left | string |||
| extra | extra text, display on the top right | string |||
| colon | change default props colon value of Descriptions Item | boolean || true |
| labelClassName | custom label class name | string |||
| contentClassName | custom content class name | string |||
| labelStyle | custom label style | object |||
| contentStyle | custom content style | object |||

### Descriptions Slots

| Name | Description |
|------|--------|
| title | custom title, display on the top left |
| extra | custom extra area, display on the top right |

### Descriptions Item Attributes
| Attribute | Description | Type | Accepted Values | Default |
|------------- |---------------- |---------------- |---------------------- |-------- |
| label | label text | string |||
| span | colspan of column | number || 1 |
| labelClassName | custom label class name | string |||
| contentClassName | custom content class name | string |||
| labelStyle | custom label style | object |||
| contentStyle | custom content style | object |||

### Descriptions Item Slots

| Name | Description |
|------|--------|
| label | custom label |
Loading

1 comment on commit b339036

@misnskn
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

descriptions组件引入没效果,vue2的项目

Please sign in to comment.