Vue3-tools NPM

Vue3 tools

Description

A collection of ready-to-use VueJS 3 tools

List

Getting started

Installation

npm install vue3-tools

Watch out: this command will install all of the tools from the library, in future we will try to enable the possibility of including single tools at the time.

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. Before starting please read the following list explaining all the custom md headers that you may find into the docs.

Implementing: this header is usually followed by a list (of one or more elements), every list item contains an external npm package that is being implemented.

@vue/cli

install
import library

import Vue3Tools from 'vue3-tools';

export default {
  components: { // register one of the components
    Audioplayer:Vue3Tools.ToolAudioplayer
  }
};

<template>

  <Audioplayer
    id="my-audio-player"
    src="source-url"
    srcType="mp3"
    srcTitle="audio title"
    ui="embedded"
  />

  <!-- DONE, as simple as that! -->

</template>