Skip to content

Latest commit

 

History

History
103 lines (65 loc) · 3.18 KB

README.md

File metadata and controls

103 lines (65 loc) · 3.18 KB
Raw

dt-react-component

React UI component library based on Ant Design

NPM version NPM downloads

English | 简体中文

Docs

You can view online document

or view legacy documents following:

React UI component library based on Ant Design. Mainly used for middle and back-end products. Our goal is to meet more specific and more specific business scenario components. Of course, we also have excellent business components based on native javascript, such as ContextMenu, KeyEventListener and so on.

When to use

  • When you find that the basic components provided by other component libraries do not meet the current business scenario, and you need to implement functions based on the basic components, you can use dt-react-component to solve the problem.
  • When the business is complex, more and more business components are deposited. In order to better manage the components and reduce the redundancy of the code, you can use dt-react-component. Of course, we welcome PR. We will review and merge common business scenario components in a timely manner.

Install

# use npm
npm install dt-react-component

# use yarn
yarn add dt-react-component

# use pnpm
pnpm install dt-react-component

Usage

import React from 'react';
import { BlockHeader } from 'dt-react-component';
const App = () => <BlockHeader title="分类标题" showBackground />;

Load on demand

We supports tree shaking of ES modules, so using import { BlockHeader } from 'dt-react-component'; would drop js code you didn't use.

TypeScript

dt-react-component is written in TypeScript with complete definitions, So you will have a better smart reminder experience.

How to contribute

CONTRIBUTING

Development

clone locally:

$ git clone [email protected]:DTStack/dt-react-component.git
$ cd dt-react-component
$ pnpm install
$ pnpm run dev

Open your browser and visit http://127.0.0.1:8000，We manage components based on dumi. see more at dumi.

Publish

pnpm build
# pnpm@6
pnpm release -- -r 3.0.1
npm publish --registry https://registry.npmjs.org/

Publish website

pnpm deploy

Contributing

We welcome all contributions. You can submit any ideas as pull requests or as issues.

Finally, thank all our code contributors

License

ISC