# @aligov/descriptions

> 描述列表

Latest version **1.0.2** (published 2020-01-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @aligov/descriptions
pnpm add @aligov/descriptions
yarn add @aligov/descriptions
bun add @aligov/descriptions
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-01-13 |
| First published | 2019-11-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 317.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | itrip, liunian, tao1991123, xiazhiqiang |
| Keywords | ice, react, component |

## Links

- npm: https://www.npmjs.com/package/@aligov/descriptions
- Homepage: https://unpkg.com/@aligov/descriptions@1.0.2/build/index.html
- npm.io page: https://npm.io/package/@aligov/descriptions

## Dependencies (3)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.8
- [@alifd/next](https://npm.io/package/@alifd/next.md) 1.x

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-01-13
- 1.0.1 — 2019-11-14
- 1.0.0 — 2019-11-11

## README

# @aligov/descriptions

成组展示多个只读字段。

> fork 自 antd 的 [descriptions 组件](https://ant.design/components/descriptions-cn/)，移除了响应式功能。

## 何时使用

常见于详情页的信息展示。

## API

### Descriptions

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| title | 描述列表的标题，显示在最顶部 | ReactNode |
| bordered | 是否展示边框 | boolean | false |
| column | 一行的 `DescriptionItems` 数量 | number | 3 |
| size | 设置列表的大小。可以设置为 `middle` 、`small`, 或不填（只有设置 `bordered={true}` 生效） | `default | middle | small` | false |
| layout | 描述布局 | `horizontal | vertical` | `horizontal` |
| colon | 配置 `Descriptions.Item` 的 `colon` 的默认值 | boolean | true |

### DescriptionItem

| 参数  | 说明         | 类型      | 默认值 | 版本   |
| ----- | ------------ | --------- | ------ | ------ |
| label | 内容的描述   | ReactNode | -      | 3.19.0 |
| span  | 包含列的数量 | number    | 1      | 3.19.0 |

> span 是 Description.Item 的数量。 span={2} 会占用两个 DescriptionItem 的宽度。

---
_Source: https://npm.io/package/@aligov/descriptions · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._