A jquery plugin that make a select more functional.
- Main files
- Quick start
- Requirements
- Usage
- Examples
- Options
- Methods
- Events
- No conflict
- Browser support
- Contributing
- Development
- Changelog
- Copyright and license
dist/
├── jquery-asSelect.js
├── jquery-asSelect.es.js
├── jquery-asSelect.min.js
└── css/
├── asSelect.css
└── asSelect.min.css
Several quick start options are available:
- Development - unminified
- Production - minified
bower install jquery-asSelect --save
npm install jquery-asSelect --save
yarn add jquery-asSelect
If you want build from source:
git clone git@github.com:amazingSurge/jquery-asSelect.git
cd jquery-asSelect
npm install
npm install -g gulp-cli babel-cli
gulp build
Done!
jquery-asSelect
requires the latest version of jQuery
.
<link rel="stylesheet" href="/path/to/asSelect.css">
<script src="/path/to/jquery.js"></script>
<script src="/path/to/jquery-asSelect.js"></script>
<select class="example">
<option value="a">beijing</option>
<option value="b">fujian</option>
<option value="c">zhejiang</option>
<option value="d">tianjin</option>
<option value="e">shanghai</option>
</select>
All you need to do is call the plugin on the element:
jQuery(function($) {
$('.example').asSelect();
});
There are some example usages that you can look at to get started. They can be found in the examples folder.
jquery-asSelect
can accept an options object to alter the way it behaves. You can see the default options by call $.asSelect.setDefaults()
. The structure of an options object is as follows:
{
namespace: 'asSelect',
skin: null,
trigger: 'click', // 'hover' or 'click'
offset: [0, 0], // set panel offset to trigger element
json: null, // if is a object,it will build from the object
preload: false, // preload some data set in load option
load: null, // preload data set here
maxHeight: 350, // set panel maxHeight, lists' height is bigger than maxHeight, scroll bar will show
select: undefined, // set initial selest value
render: {
label(selected) {
if (selected) {
return selected.text;
}
return 'Choose one';
},
option(item) {
return item.text;
},
group(item) {
return item.label;
}
},
onChange: function() {}
}
Methods are called on asSelect instances through the asSelect method itself. You can also save the instances to variable for further use.
// call directly
$().asSelect('destroy');
// or
var api = $().data('asSelect');
api.destroy();
Show the select dropdown
$().asSelect('show');
Hide the select dropdown
$().asSelect('hide');
Set the select value if value is defined or get the value.
// set the val
$().asSelect('val', '5');
// get the val
var value = $().asSelect('val');
Set the select value
$().asSelect('set', '5');
Get the select value.
var value = $().asSelect('get');
Enable the select functions.
$().asSelect('enable');
Disable the select functions.
$().asSelect('disable');
Destroy the select instance.
$().asSelect('destroy');
jquery-asSelect
provides custom events for the plugin’s unique actions.
$('.the-element').on('asSelect::ready', function (e) {
// on instance ready
});
Event | Description |
---|---|
init | Fires when the instance is setup for the first time. |
ready | Fires when the instance is ready for API use. |
change | Fires when the value is changing |
enable | Fired immediately when the enable instance method has been called. |
disable | Fired immediately when the disable instance method has been called. |
destroy | Fires when an instance is destroyed. |
If you have to use other plugin with the same namespace, just call the $.asSelect.noConflict
method to revert to it.
<script src="other-plugin.js"></script>
<script src="jquery-asSelect.js"></script>
<script>
$.asSelect.noConflict();
// Code that uses other plugin's "$().asSelect" can follow here.
</script>
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.
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-asSelect
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
jquery-asSelect
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.
To see the list of recent changes, see Releases section.
Copyright (C) 2016 amazingSurge.
Licensed under the LGPL license.