https://github.com/mfazail/vue-quick-notes

Quickly add notes to admin panel/dashboard or websites.
https://github.com/mfazail/vue-quick-notes

admin-notes notes vue vue3

Last synced: about 1 month ago
JSON representation

Quickly add notes to admin panel/dashboard or websites.

• Host: GitHub
• URL: https://github.com/mfazail/vue-quick-notes
• Owner: mfazail
• Created: 2022-04-27T06:17:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-04-28T08:43:17.000Z (over 2 years ago)
• Last Synced: 2024-11-10T18:14:53.170Z (2 months ago)
• Topics: admin-notes, notes, vue, vue3
• Language: Vue
• Homepage: https://mfazail.github.io/vue-quick-notes/
• Size: 146 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Vue Quick Notes

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




  

  



## Installation

### npm

Use npm to install.

```bash

npm i vue-quick-notes

```

## Usage

```js

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

// style import is needed to work propperly

import "vue-quick-notes/dist/style.css";

```

```html

```

## Composable

```js

// 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