Skip to content
πŸ› οΈ vue-cli 3 plugin to create component
JavaScript Vue
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
generator πŸ”– ⬆️ updating component fixture version Dec 17, 2018
LICENSE Add License Jul 24, 2018 Update Dec 2, 2018
index.js First commit Jul 23, 2018
logo.png WIP Jul 23, 2018
package-lock.json πŸ’„ using PascalCase for component name Dec 16, 2018
package.json πŸ”– ⬆️ updating component fixture version Dec 17, 2018
prompts.js πŸ’„ using PascalCase for component name Dec 16, 2018


Npm version npm MIT License

component plugin for vue-cli


β”‚   LICENSE (optional)
β”‚   β”œβ”€β”€ index.js
β”‚   └───components
β”‚       └───Mycomponent.vue
    β”œβ”€β”€ App.vue
    β”œβ”€β”€ main.js


  • Adjust build script to only build the component. Use serve script to serve a demo page.

  • Create a prepublishOnly script to run the build(s) before publishing the component

  • Update with component information

  • Optional


Use build to build the component

npm run build

Use serve to serve the application example in the example folder

npm run serve

When using vue.doc

Use doc:build to update the API section of with generated documentation

npm run doc:build

When using vueStyleguide

Use styleguide to run style guide dev server

npm run styleguide

Use styleguide:build to generate a static HTML style guide

npm run styleguide:build



  • componentName: the name of the component.

  • useVueStyleguidist: true to install vue-styleguidist, default: true

  • useVueDoc: true to install, default: true

  • addLicense true to add a License file to the project, default: false

  • licenseName type of the license file to create, default: MIT

  • copyrightHolders Project copy holders, used when creating the license file.

Injected Commands

No command will be injected.

Installing in an Already Created Project

vue add component

Injected webpack-chain Rules

No Changes are performed

You can’t perform that action at this time.