@sis-ter/vue3-tools
v1.2.4
Published
A library for ready to use vue3 components
Downloads
65
Readme
Vue3 tools
A collection of ready-to-use VueJS 3 components
List
Getting started
Installation
npm install @sis-ter/vue3-tools
Usage
We recomend using this library with a @vue/cli
project and single file components (SFC -> .vue
)
It is also possible to include the common.js
version, .umd.js
or .umd.min.js
all of which can be found into the dist folder
Reading the docs
In the folder docs
you may find all the documentation regarding every tool of the library.
@vue/cli
There are 2 ways to import the plugin:
- import directly into
.vue
file - register components in
src/main.js
Case 1 --> direct import
import Vue3Tools from 'vue3-tools';
export default {
components: { // register one of the components
'audio-player': Vue3Tools.ToolAudioplayer
}
};
Case 2 --> register component(s)
// src/main.js
import { install } from "../../src/index.js";
// leave empty to register all the components
const options =
[{
name: "audio-player",
as: "tool-audio-player",
},
"login"]
createApp(App)
.use(store)
.use(router)
.use(install,options)
.mount("#app");
Use component
<template>
<audio-player
:source="[{ url: 'source-url', type: 'audio/mp3' }]"
type="audio/mp3"
/>
<!-- DONE, as simple as that! -->
</template>
Support
For any question or issue please write an email to Pietro Monsorno or open a GitLab issue onto the library's repository
Roadmap
// TODO
Contributing
You're more than welcome to help us out! Reach out to the maintainer to be granted access.
Authors and acknowledgment
This library is licensed under the MIT license, be free to use it as you like.
Maintainers
Pietro Monsorno [email protected]
Contributors
404
License
Project status
// TODO