# @ant-design/pro-descriptions

> @ant-design/pro-descriptions

Latest version **2.6.10** (published 2025-07-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ant-design/pro-descriptions
pnpm add @ant-design/pro-descriptions
yarn add @ant-design/pro-descriptions
bun add @ant-design/pro-descriptions
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.6.10 |
| Published | 2025-07-17 |
| First published | 2020-07-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 58.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4829 |
| Maintainers | afc163, zombiej, chenshuai2144, arvinxx, madccc |
| Keywords | antd, admin, ant-design, ant-design-pro |

## Links

- npm: https://www.npmjs.com/package/@ant-design/pro-descriptions
- Repository: https://github.com/ant-design/pro-components
- Homepage: https://github.com/ant-design/pro-components/tree/master/packages/descriptions#readme
- Issues: http://github.com/umijs/plugins/issues
- npm.io page: https://npm.io/package/@ant-design/pro-descriptions

## Dependencies (8)

- [rc-util](https://npm.io/package/rc-util.md) ^5.0.6
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.18.0
- [rc-resize-observer](https://npm.io/package/rc-resize-observer.md) ^0.2.3
- [@ant-design/pro-form](https://npm.io/package/@ant-design/pro-form.md) 2.32.0
- [@ant-design/pro-field](https://npm.io/package/@ant-design/pro-field.md) 3.1.0
- [@ant-design/pro-utils](https://npm.io/package/@ant-design/pro-utils.md) 2.18.0
- [@ant-design/pro-provider](https://npm.io/package/@ant-design/pro-provider.md) 2.16.2
- [@ant-design/pro-skeleton](https://npm.io/package/@ant-design/pro-skeleton.md) 2.2.1

## Recent versions

- 2.6.10 (latest) — 2025-07-17
- 1.12.7 (old) — 2022-10-26
- 2.0.0-alpha.43 (next) — 2022-10-13
- 2.0.0-experimental.42 (experimental) — 2022-09-07
- 1.10.54 (tag) — 2022-03-15
- 2.6.9 — 2025-06-10
- 2.6.8 — 2025-06-10
- 2.6.7 — 2025-03-31
- 2.6.6 — 2025-02-17
- 2.6.5 — 2025-02-12
- 2.6.4 — 2025-01-18
- 2.6.3 — 2025-01-06
- 2.6.2 — 2024-11-14
- 2.6.1 — 2024-10-22
- 2.6.0 — 2024-10-17
- … 416 more at https://npm.io/package/@ant-design/pro-descriptions/versions

## README

# @ant-design/pro-descriptions

> Advanced description list component, providing a more convenient and faster solution to build description lists.

See our website [@ant-design/pro-descriptions](https://procomponent.ant.design/) for more information.

ProDescriptions was created to solve the problem of having to write a lot of sample code for Descriptions in a project, so it encapsulates a lot of common logic in it. Writing a Descriptions in React inevitably requires defining some of the same properties. So ProDescriptions by default encapsulates the logic of requesting network, columns display.

For example, if ProDescriptions encapsulates the behavior of the request network, ProDescriptions will bring the data in props.params into the request by default, and if the interface happens to be the same as our definition, it will be very easy to implement a query.

```tsx | pure
import request from 'umi-request';

const fetchData = (params) =>
  request<{
    data: T{};
  }>('https://proapi.azurewebsites.net/github/issues', {
    params,
  });

const keyWords = "Ant Design"

<ProDescriptions<T,U> request={fetchData} />;
```

We agree that request has one parameter and `params` will take its own `params` in props. The type is as follows:

```tsx | pure
(params: U) => RequestData;
```

There are also conventions for ProDescriptions with the results of the request back, of the following type.

```tsx | pure
interface RequestData {
  data: Datum{};
  success: boolean;
}
```

## Install

Using npm:

```bash
$ npm install --save  @ant-design/pro-descriptions
```

or using yarn:

```bash
$ yarn add @ant-design/pro-descriptions
```

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