jquery-selective
v0.3.5
Published
A jquery plugin that used to tagging, selectors and so on.
Downloads
1,950
Maintainers
Readme
jQuery selective
A jquery plugin that used to tagging, selectors and so on.
Table of contents
- Main files
- Quick start
- Requirements
- Usage
- Examples
- Options
- Methods
- Events
- No conflict
- Browser support
- Contributing
- Development
- Changelog
- Copyright and license
Main files
dist/
├── jquery-selective.js
├── jquery-selective.es.js
├── jquery-selective.min.js
└── css/
├── selective.css
└── selective.min.css
Quick start
Several quick start options are available:
Download the latest build
- Development - unminified
- Production - minified
Install From Bower
bower install jquery-selective --save
Install From Npm
npm install jquery-selective --save
Install From Yarn
yarn add jquery-selective
Build From Source
If you want build from source:
git clone [email protected]:amazingSurge/jquery-selective.git
cd jquery-selective
npm install
npm install -g gulp-cli babel-cli
gulp build
Done!
Requirements
jquery-selective
requires the latest version of jQuery
and jquery-mousewheel
if we need mouse wheel support.
Usage
Including files:
<link rel="stylesheet" href="/path/to/selective.css">
<script src="/path/to/jquery.js"></script>
<script src="/path/to/jquery.mousewheel"></script>
<script src="/path/to/jquery-selective.js"></script>
Required HTML structure
<div class="example"></div>
Initialization
All you need to do is call the plugin on the element:
jQuery(function($) {
$('.example').selective();
});
Examples
There are some example usages that you can look at to get started. They can be found in the examples folder.
Options
jquery-selective
can accept an options object to alter the way it behaves. You can see the default options by call $.selective.setDefaults()
. The structure of an options object is as follows:
{
namespace: 'selective',
buildFromHtml: true,
closeOnSelect: false,
local: null,
selected: null,
withSearch: false,
searchType: null, //'change' or 'keyup'
ajax: {
work: false,
url: null,
quietMills: null,
loadMore: false,
pageSize: null
},
query: function() {}, //function(api, search_text, page) {},
tpl: {
frame: function() {
return `<div class="${this.namespace}"><div class="${this.namespace}-trigger">${this.options.tpl.triggerButton.call(this)}<div class="${this.namespace}-trigger-dropdown"><div class="${this.namespace}-list-wrap">${this.options.tpl.list.call(this)}</div></div></div>${this.options.tpl.items.call(this)}</div>`;
},
search: function() {
return `<input class="${this.namespace}-search" type="text" placeholder="Search...">`;
},
select: function() {
return `<select class="${this.namespace}-select" name="${this.namespace}" multiple="multiple"></select>`;
},
optionValue: function(data) {
if('name' in data) {
return data.name;
} else {
return data;
}
},
option: function(content) {
return `<option value="${this.options.tpl.optionValue.call(this)}">${content}</option>`;
},
items: function() {
return `<ul class="${this.namespace}-items"></ul>`;
},
item: function(content) {
return `<li class="${this.namespace}-item">${content}${this.options.tpl.itemRemove.call(this)}</li>`;
},
itemRemove: function() {
return `<span class="${this.namespace}-remove">x</span>`;
},
triggerButton: function() {
return `<div class="${this.namespace}-trigger-button">Add</div>`;
},
list: function() {
return `<ul class="${this.namespace}-list"></ul>`;
},
listItem: function(content) {
return `<li class="${this.namespace}-list-item">${content}</li>`;
}
},
onBeforeShow: null,
onAfterShow: null,
onBeforeHide: null,
onAfterHide: null,
onBeforeSearch: null,
onAfterSearch: null,
onBeforeSelected: null,
onAfterSelected: null,
onBeforeUnselect: null,
onAfterUnselect: null,
onBeforeItemRemove: null,
onAfterItemRemove: null,
onBeforeItemAdd: null,
onAfterItemAdd: null
}
Methods
Methods are called on selective instances through the selective method itself. You can also save the instances to variable for further use.
// call directly
$().selective('destroy');
// or
var api = $().data('selective');
api.destroy();
enable()
Enable the selective functions.
$().selective('enable');
disable()
Disable the selective functions.
$().selective('disable');
destroy()
Destroy the selective instance.
$().selective('destroy');
Events
jquery-selective
provides custom events for the plugin’s unique actions.
$('.the-element').on('selective::ready', function (e) {
// on instance ready
});
Event | Description
------- | -----------
ready | Fires when the instance is ready for API use.
enable | Fired when the enable
instance method has been called.
disable | Fired when the disable
instance method has been called.
destroy | Fires when an instance is destroyed.
No conflict
If you have to use other plugin with the same namespace, just call the $.selective.noConflict
method to revert to it.
<script src="other-plugin.js"></script>
<script src="jquery-selective.js"></script>
<script>
$.selective.noConflict();
// Code that uses other plugin's "$().selective" can follow here.
</script>
Browser support
Tested on all major browsers.
| | | | | | | |:--:|:--:|:--:|:--:|:--:|:--:| | Latest ✓ | Latest ✓ | Latest ✓ | Latest ✓ | 9-11 ✓ | Latest ✓ |
As a jQuery plugin, you also need to see the jQuery Browser Support.
Contributing
Anyone and everyone is welcome to contribute. Please take a moment to
review the guidelines for contributing. Make sure you're using the latest version of jquery-selective
before submitting an issue. There are several ways to help out:
- Bug reports
- Feature requests
- Pull requests
- Write test cases for open bug issues
- Contribute to the documentation
Development
jquery-selective
is built modularly and uses Gulp as a build system to build its distributable files. To install the necessary dependencies for the build system, please run:
npm install -g gulp
npm install -g babel-cli
npm install
Then you can generate new distributable files from the sources, using:
gulp build
More gulp tasks can be found here.
Changelog
To see the list of recent changes, see Releases section.
Copyright and license
Copyright (C) 2016 amazingSurge.
Licensed under the LGPL license.