\n\nYou can use this project to quickly create a component library based on vue 3.0. This is a super fast and super simple way to generate vue component library!\n\n## [Documentation](https://ckpack.github.io/v-ui/)\n\n## Features\n\n- Quickly add new components via commands\n- All components support on-demand loading by default\n- Customizable component prefix to avoid component name and style conflicts\n- Support component library document generation\n\n## Script commands\n\nFor detailed commands, refer to the `scripts` part of `package.json`\n\n```bash\n# Installation dependencies\nnpm install\n\n# Add new component\nnpm run gen component-name\n\n# Package your component library\nnpm run build\n\n# Check the code specification\nnpm run lint\n\n# Generate log file to release new version\nnpm run release\n\n# Generate documentation related commands\nnpm run docs:build\n```\n\n## download\n\n```bash\n# git clone\ngit clone https://github.com/ckpack/v-ui.git\n\n# download zip\nhttps://github.com/ckpack/v-ui/archive/refs/heads/main.zip\n```\n\n## Global replacement variables\n\n- `v-ui` is `you-project-name` such as `b-ui`\n- `ckpack` is `you-github-username` such as `my-github-username`\n\n## Modify component prefix\n\nThe default component prefix is `V`, you can choose to modify the component prefix\nModify the file `src/defaultConfig.js`\n\n```js\n// modify the ouput when iife format, such as `TUI`\nexport const NAME = \"TUI\";\n// Modify the default component prefix, such as `B`\nexport const COMPONENT_PREFIX = \"B\";\n```\n\nThe default component class prefix is `v-`, you can choose to modify the component class prefix\nModify the file `src/styles/config.scss`\n\n```scss\n// Modify the default component class prefix such as `t`\n$namespace: t !default;\n```\n\n## Start creating components\n\nUse `npm run gen component-name` to add new components. For example, execute the `npm run gen select` command, which will generate the `select` file directory under the `src/components/` directory, and edit the `select` under the folder. vue`file and`index.scss` file\n\n#### Preview the newly generated components\n\nIntroduce new components in the file `dev/app.vue`, execute `npm run dev` to preview the new components\n\n```diff\n\n
\n \n+ \n \n
\n\n\n\n```\n\n#### Add new component document\n\nAdd the document corresponding to the component name in the `docs/guide/compoents` folder, execute `npm run docs:dev` to preview the document\n\n```md\n\n\n# Select\n\nTest component\n\n\n```\n","readmeFilename":"README.md"}