/cosine-ui

基于个人兴趣开发的一个 React 组件库,尝试了 Tailwind+TypeScript 在组件库中的实践,利用dumi生成文档及demo演示,使用 Tailwind JIT mode 开发

Primary LanguageTypeScript

cosine-ui

npm version Actions Status code style: prettier

组件库文档

cosine-ui 是出于个人兴趣开发的一个 React 组件库,尝试了 tailwind+TypeScript 在组件库中的实践,并使用 Tailwind JIT mode 开发,无需引入全量 Tailwind CSS,使用 dumi 进行文档的生成

此组件库还在开发中,还有很多地方有待完善,包括测试用例、通用组件等

项目中安装

在开始之前,需要具备 Nodejs 环境或使用 yarn

从 npm 或 yarn 安装并引入 cosine-ui

npm i cosine-ui
# or
yarn add cosine-ui

从源码构建

下载

git clone git@github.com:yusixian/cosine-ui.git

安装依赖

npm i
# or
yarn

以开发模式运行

npm start
# or
yarn start

构建文档

npm run docs:build
# or
yarn docs:build

运行测试

npm test
# or
yarn test

通过 father 构建 dist 产物

$ npm run build