Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryanfitzgerald/tagselector
Dependency-free JS library that turns select fields in customizable tag clouds
https://github.com/ryanfitzgerald/tagselector
demo dropdown javascript list multiple select tag-cloud tags
Last synced: 18 days ago
JSON representation
Dependency-free JS library that turns select fields in customizable tag clouds
- Host: GitHub
- URL: https://github.com/ryanfitzgerald/tagselector
- Owner: RyanFitzgerald
- License: mit
- Created: 2016-05-16T13:34:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-14T19:14:08.000Z (about 7 years ago)
- Last Synced: 2024-10-17T16:13:41.881Z (29 days ago)
- Topics: demo, dropdown, javascript, list, multiple, select, tag-cloud, tags
- Language: JavaScript
- Homepage: http://ryanfitzgerald.github.io/tagselector/
- Size: 188 KB
- Stars: 18
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Tag Selector
Lightweight (~2kb gzipped), ES6 Class-based library for turning select fields into customizable and user friendly tag clouds.
Features include:
* ES6 Class-based (Transpiled to ES5 / CommonJS)
* ~2kb in size gzipped
* 100% Dependency free
* Comes completely unstyled or with an optional base theme (see screenshot)
* Easy to style with well-named CSS classes
* Mobile Friendly
### [See demo here](http://ryanfitzgerald.github.io/tagselector/)
This library works by simply hiding and changing the hidden select field behind the scenes as user selects tags. The way you handle forms with selects remains the same, however users get a much more user friendly experience.
## Installation
Via NPM:
```
npm install --save tagselector
```
Or simply download `dist/tagselector.js` manually if not using NPM.
Then simply include it however you like:
```javascript
const TagSelector = require('tagselector');
```
or
```html
```
## Usage
To use, simply create a select field with a unique ID, as well as some options with text and values:
```html
Orange
Apple
```
*Note: Add `multiple` to the select in order to get multiselect functionality with the tag cloud.*
Next, create a new instance of tagselector and pass in the Javascript Object reference:
```javascript
var selectField = document.getElementById('someSelect');
var tagSelector = new TagSelector(selectField);
```
To **reload** a current instance, simply do the following:
```javascript
var selectField = document.getElementById('someSelect');
var tagSelector = new TagSelector(selectField);
tagSelector.reload();
```
You can also **destroy** the instance as follows:
```javascript
var selectField = document.getElementById('someSelect');
var tagSelector = new TagSelector(selectField);
tagSelector.destroy();
```
### Customization
Tag selector comes with a number of customizations that can be passed as an optional parameter:
```javascript
var selectField = document.getElementById('someSelect');
var tagSelector = new TagSelector(selectField, {
max: 2,
onInit: function() {
console.log('inited!')
},
onDestroy: function() {
console.log('destroyed!')
},
onSelect: function(value, text) {
console.log(`Selected item with value: '${value}' and text: '${text}'`)
},
onDeselect: function(value, text) {
console.log(`Deselected item with value: '${value}' and text: '${text}'`)
}
});
```
| Setting | Description | Default |
| ------- | ----------- | ------- |
| max | Sets a maximum number of selects at a given time (only works with multiselect) | false |
| onInit | Callback function after new instance of tag selector is created | false |
| onDestroy | Callback function after instance of tag selector is destroyed | false |
| onSelect | Callback function after a new tag is selected. Params received are option value and text | false |
| onDeselect | Callback function after a tag is deselected. Params received are option value and text | false |
## Styles
By default, the wrapper and tags don't come with any styling, leaving the look and feel completely up to you. The classes available to style are as follows:
| Class Name | Description |
| ---------- | ----------- |
| .tagselector-wrap | The wrapper div surrounding all tags |
| .tagselector-tag | Each individiual tag span |
| .active | Class applied to any actively selected tag |
If you would also like some basic styling out of the box (like in the screenshot above), include the CSS: ``dist/tagselector.css``.
## License
MIT License. See LICENSE.MD