Skip to content

scalars/vue-modules-ts

Repository files navigation

Vue Modules

The most dynamic vue modules package, Ever

####Powered by:

madrov

Vue-modules-ts is a package that provides a lot of components for easy use and implementation, to use in your vue ts projects. In addition to that we have a tool that will allow you to create your own modules on an easy way.

Installation

Use the package manager yarn or npm to install foobar.

yarn install

Usage

To generate a new component you just need to use the command bellow

yarn new 

after this a text will be displayed requesting the name of the new component

? input the component name [componentName]

To consider, [componentName] will be written on lowerCamelCase, otherwise, it indicates that the component is not named correctly, blank spaces, hyphens, underscores or special characters are not accepted either

Incorrect name error:

>> please enter a valid camelCase name

If the process runs successfully, the console will return the result with the respective files associated with the component

Creating Files in: /.../vue-modules-ts/packages/modules/example-component
.browserslistrc
.gitignore
babel.config.js
tsconfig.json
vue.config.js
App.vue
main.ts
shims-tsx.d.ts
shims-vue.d.ts
creating story in: /.../vue-modules-ts/packages/storybook/stories/example-component
exampleComponent.stories.ts
Done in 7721.58s.
batmanuser@batmanuser-PC:~/Documentos/Projects/vue-modules-ts$

Nested Components

If you want to create a nested component inside another folder, you need to define the path as follows

? input the component name [componentParentFolder]/[componentName]

in this case [componentParentFolder] is the main folder where the respective components belonging to that class of components are contained.

The expected results are similar to the previous process

? input the component name buttons/badButtons
Creating Files in: /.../vue-modules-ts/packages/modules/buttons/bad-buttons
.browserslistrc
.gitignore
babel.config.js
tsconfig.json
vue.config.js
App.vue
main.ts
shims-tsx.d.ts
shims-vue.d.ts
creating story in: /.../vue-modules-ts/packages/storybook/stories/buttons/bad-buttons
badButtons.stories.ts
Done in 64.24s.

And that's it, your component is ready to be encoded.

Implementation

To implement this component on your project you just need to install

About

monorepository for vue modules on typescript

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published