dance ui

dance-ui

? A simple and elegant component library.

React component library developed using pnpm+vite+ts+tailwind, organized by monorepo, and document sites are built using Docusaurus

Document site online address: https://dance.cosine.ren/

Github address: https://github.com/dancing-team/dance-ui

NPM package: https://www.npmjs.com/package/@dance-ui/ui

Update log: CHANGE_LOG

? Start quickly

pnpm i @dance-ui/ui

Introducing components: Component full view

 import { Button } from '@dance-ui/ui'

export default ( ) => {
  return < Button type = "primary" > Primary </ Button >
}

? Local development

 # install decencies
pnpm i
# build ui & start docs
pnpm start

script description

• start executes build:ui package component library, start:docs to start the document site in turn
• start:docs does not package the component library and directly start the document site, which is suitable for situations where it has been packaged once.
• start:demo packages the component library and starts the demo project
• build the component library and package the document site
• build:ui package component library separately
• build:ui-watch separately packages the component library and monitors changes and updates in real time. In conjunction with start:demo, you can monitor component modification effects in real time.
• serve:docs preview document site
• change execution uses changeset add to record version modification
• new script to create new component
• lint performs eslint code check on component library

New component development

• fork this warehouse
• cd root directory, pnpm new to create a new component, enter the Chinese name and English name of the component
• After creating, go to packages/components/src directory to find the components you created for development. The corresponding document is located in packagesexampledocscomponents
• After the component development is completed, pnpm change can record the update log, and this step can also be done (merge PR and then make adjustments)