# @pluginjs/tag-list

> A flexible modern tag-list js plugin.

Latest version **0.8.12** (published 2022-08-29) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @pluginjs/tag-list
pnpm add @pluginjs/tag-list
yarn add @pluginjs/tag-list
bun add @pluginjs/tag-list
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.12 |
| Published | 2022-08-29 |
| First published | 2017-12-26 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 8 |
| Dependencies | 9 |
| Unpacked size | 36.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Creation Studio Limited |
| Maintainers | thecreation, kaptinlin |

## Links

- npm: https://www.npmjs.com/package/@pluginjs/tag-list
- Repository: https://github.com/pluginjs/pluginjs
- Homepage: https://pluginjs.com
- Issues: https://github.com/pluginjs/pluginjs/issues
- npm.io page: https://npm.io/package/@pluginjs/tag-list

## Dependencies (9)

- [@pluginjs/is](https://npm.io/package/@pluginjs/is.md) ^0.8.9
- [@pluginjs/dom](https://npm.io/package/@pluginjs/dom.md) ^0.8.10
- [@pluginjs/list](https://npm.io/package/@pluginjs/list.md) ^0.8.12
- [@pluginjs/utils](https://npm.io/package/@pluginjs/utils.md) ^0.8.10
- [@pluginjs/events](https://npm.io/package/@pluginjs/events.md) ^0.8.11
- [@pluginjs/factory](https://npm.io/package/@pluginjs/factory.md) ^0.8.10
- [@pluginjs/template](https://npm.io/package/@pluginjs/template.md) ^0.8.10
- [@pluginjs/component](https://npm.io/package/@pluginjs/component.md) ^0.8.9
- [@pluginjs/decorator](https://npm.io/package/@pluginjs/decorator.md) ^0.8.11

## Recent versions

- 0.8.12 (latest) — 2022-08-29
- 0.8.11 — 2022-01-08
- 0.8.7 — 2021-03-25
- 0.8.6 — 2021-03-01
- 0.8.5 — 2020-08-27
- 0.8.4 — 2020-07-11
- 0.8.3 — 2020-02-11
- 0.8.2 — 2020-02-11
- 0.7.21 — 2019-12-17
- 0.7.20 — 2019-12-16
- 0.7.19 — 2019-09-20
- 0.7.18 — 2019-08-06
- 0.7.17 — 2019-07-22
- 0.7.16 — 2019-06-28
- 0.7.15 — 2019-05-31
- … 36 more at https://npm.io/package/@pluginjs/tag-list/versions

## README

# TagList

[![npm package](https://img.shields.io/npm/v/@pluginjs/tag-list.svg)](https://www.npmjs.com/package/@pluginjs/tag-list)

A flexible modern tag-list js plugin.

**[Samples](https://codesandbox.io/s/github/pluginjs/pluginjs/tree/master/modules/tagList/samples)**

## Introduction
### Installation

#### Yarn

```javascript
yarn add @pluginjs/tag-list
```

#### NPM

```javascript
npm i @pluginjs/tag-list
```

## Getting Started

**CDN:**

Development:

```html
<script src="https://unpkg.com/@pluginjs/tag-list/dist/tag-list.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/tag-list/dist/tag-list.css">
```

Production:

```html
<script src="https://unpkg.com/@pluginjs/tag-list/dist/tag-list.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/tag-list/dist/tag-list.min.css">
```

### Initialize

HTML:

```html
<div class="element"></div>
```

ECMAScript Module:

```javascript
import TagList from "@pluginjs/tag-list"
import "@pluginjs/tag-list/dist/tag-list.css"

TagList.of(document.querySelector('.element'), options)
```

CommonJS:

```javascript
require("@pluginjs/tag-list/dist/tag-list.css")
const TagList = require("@pluginjs/tag-list")

TagList.of(document.querySelector('.element'), options)
```

Browser:

```html
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/tag-list/dist/tag-list.css">
<script src="https://unpkg.com/@pluginjs/tag-list/dist/tag-list.js"></script>
<script>
  Pj.tagList('.element', options)
</script>
```

## API

### Options

Options are called on tagList instances through the tagList options itself.
You can also save the instances to variable for further use.

Name | Description | Default
--|--|--
`"theme"` | Set plugin theme option | `null`
`"locale"` | Set locale environment | `en`
`"localeFallbacks"` | Set localeFallbacks | `true`
`"data"` | Set data | `null`
`"actions"` | Set actions | `[{"tagName":"i","trigger":"icon-close pj-list-close","event":"click"}]`
`"templates"` | Set default templates | `{}`

### Events

Events are called on tagList instances through the tagList events itself.
You can also save the instances to variable for further use.

Name | Description
--|--
`"update"` | Gets fired when plugin has destroy
`"ready"` | Gets fired when plugin has ready
`"enable"` | Gets fired when plugin has enabled
`"disable"` | Gets fired when plugin has disabled
`"destroy"` | Gets fired when plugin has destroy

### Methods

Methods are called on tagList instances through the tagList method itself.
You can also save the instances to variable for further use.

Name | Description
--|--
`"value"` | Get value
`"enable"` | Enabled plugin if plugin is disabled
`"disable"` | Disable plugin
`"destroy"` | Destroy plugin

### Classes

Name | Description | Default
--||
`"NAMESPACE"` | Declare plugin namespace | `pj-tagList`
`"THEME"` | Declare plugin theme | `{namespace}--{theme}`
`"ADD"` | Declare plugin add | `{namespace}-add`
`"ADDINPUT"` | Declare plugin addinput | `{namespace}-input`
`"ADDBTN"` | Declare plugin addbtn | `{namespace}-btn`

### Translations

Name | EN | ZH
--||-
`"addPlaceholder"` | Enter new tags... | 添加新标签...
`"add"` | Add | 添加
`"cancel"` | Cancel | 取消
`"deleteTitle"` | Are you sure you want to delete? | 你确定要删除？
`"delete"` | Delete | 删除

## Browser support

Tested on all major browsers.

| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera |
| --------- | --------- | --------- | --------- | --------- |
| IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

## License

@pluginjs/tag-list is Licensed under [the GPL-v3 license](LICENSE).

If you want to use @pluginjs/tag-list project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us purchase@thecreation.co.

## Copyright

Copyright (C) 2022 [Creation Studio Limited](creationstudio.com).

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