Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.67 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.67 KB

Vue Quick Notes

Quickly take notes in your admin panel/dashboard or websites.

Installation

npm

Use npm to install.

npm i vue-quick-notes

Usage

import { VueQuickNotes } from "vue-quick-notes";

// style import is needed to work propperly
import "vue-quick-notes/dist/style.css";
<VueQuickNotes label="Quick notes" v-model="text" />

Composable

// Get the value of the text in any component
import { useQuickNotes } from "vue-quick-notes";

let { text, open } = useQuickNotes();

console.log(text.value);

console.log(open.value); // Use this value to show or hide quick-note

Use ctrl+alt+k to show quick note

Props

Name Type Default Detail
x number screenWidth - 350 Initial x position of div
y number screenHeight - 250 Initial y position of div
label string null Label for textarea
z-index string 20 z index of div
lang string en-US Speech recognition language
parent-class string null class of div
button-class string null class of mic button

Any other attributes will be passed to textarea