# qpam

> brings autocomplete to Quill placeholder module

Latest version **1.0.4-6** (published 2020-05-07) · SEE LICENSE IN LICENSE license · 0 weekly downloads

## Install

```sh
npm install qpam
pnpm add qpam
yarn add qpam
bun add qpam
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4-6 |
| Published | 2020-05-07 |
| First published | 2020-01-14 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 185 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | David Mamane |
| Maintainers | sanitos |
| Keywords | quill, quilljs |

## Links

- npm: https://www.npmjs.com/package/qpam
- Repository: https://github.com/OleksandrPedchenko/quill-placeholder-autocomplete
- Homepage: https://github.com/OleksandrPedchenko/quill-placeholder-autocomplete#readme
- Issues: https://github.com/OleksandrPedchenko/quill-placeholder-autocomplete/issues
- npm.io page: https://npm.io/package/qpam

## Dependencies (1)

- [quill-placeholder-autocomplete-module-fork](https://npm.io/package/quill-placeholder-autocomplete-module-fork.md) ^1.0.4-2

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 1.0.4-6 (latest) — 2020-05-07
- 1.0.4-5 — 2020-01-16
- 1.0.4-4 — 2020-01-14
- 1.0.4-3 — 2020-01-14

## README

# quill-placeholder-autocomplete
brings autocomplete to [quill-placeholder-module](https://github.com/jspaine/quill-placeholder-module)

## Install
+ using NPM:
  ```
  npm install --save quill-placeholder-autocomplete-module quill-placeholder-module
  ```
+ using yarn:
  ```
  yarn add quill-placeholder-autocomplete-module quill-placeholder-module
  ```
  
## Usage
```js
import getPlaceholderModule from 'quill-placeholder-module';
import getAutocompleteModule from 'quill-placeholder-autocomplete-module';

Quill.register('modules/placeholder', getPlaceholderModule(Quill,  { 
  className: 'ql-placeholder-content',  // default 
}));
Quill.register('modules/autocomplete', getAutocompleteModule(Quill));

const placeholders = [
  {id: 'foo', label: 'Foo'},
  {id: 'required', label: 'Required', required: true}
]

var quill = new Quill('#editor', {
  modules: {
    toolbar: {container: `#toolbar`},
    placeholder: {
      delimiters: ['{', '}'],               // default
      placeholders
    },
    autocomplete: {
      getPlaceholders: () => placeholders       // factory
      container: '#completions',               // can also be return of `document.querySelector` or keeped to `undefined`
      onOpen: () => console.log('opened'),    // optional
      onClose: (placeholder) => console.log('user choosed:', placeholder),  //optional
    }
  },
  placeholder: 'Compose an epic...',
  theme: 'snow'
});
```

---
_Source: https://npm.io/package/qpam · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._