Skip to content

Commit aeca59d

Browse files
committed
Preparing for release.
Updated docs and readme. Removed some useles files. General fixes in plugin page and make it responsive.
1 parent 29be6a0 commit aeca59d

File tree

8 files changed

+683
-539
lines changed

8 files changed

+683
-539
lines changed

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jQuery Selectric is a jQuery plugin designed to help at stylizing and manipulati
2121
Make sure to include jQuery in your page:
2222

2323
```html
24-
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
24+
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
2525
```
2626

2727
Include **jQuery Selectric:**
@@ -40,7 +40,7 @@ Initialize **jQuery Selectric:**
4040

4141
```html
4242
<script>
43-
$(function(){
43+
$(function() {
4444
$('select').selectric();
4545
});
4646
</script>
@@ -167,8 +167,8 @@ $('select').selectric({
167167
* Description: Customize classes.
168168
*/
169169
customClass: {
170-
prefix: 'selectric',
171-
camelCase: false
170+
prefix: 'selectric', // Type: String. Description: Prefixed string of every class name.
171+
camelCase: false // Type: Boolean. Description: Switch classes style between camelCase or dash-case.
172172
},
173173

174174
/*
@@ -218,7 +218,17 @@ $('select').selectric({
218218
* first (or last) once reach the end (or start) item of list upon
219219
* keyboard arrow navigation.
220220
*/
221-
allowWrap: true
221+
allowWrap: true,
222+
223+
/*
224+
* Type: Object
225+
* Description: Customize select "multiple" behavior
226+
*/
227+
multiple: {
228+
separator: ', ', // Type: String. Description: Items separator.
229+
keepMenuOpen: true, // Type: Boolean. Description: Close after an item is selected.
230+
maxLabelEntries: false // Type: Boolean or Integer. Description: Max selected items do show.
231+
}
222232
}
223233
```
224234

@@ -227,7 +237,7 @@ $('select').selectric({
227237
All events are called on original element, first argument is the original element too. And can be bound like this:
228238

229239
```js
230-
$('select').on('eventname', function(element){
240+
$('select').on('eventname', function(element) {
231241
// your code
232242
});
233243
```
@@ -263,6 +273,22 @@ $('select').on('eventname', function(element){
263273
<td><code>selectric-close</code></td>
264274
<td>Fired after select options closes</td>
265275
</tr>
276+
<tr>
277+
<td><code>selectric-before-highlight</code></td>
278+
<td>Fired before a select option is highlighted</td>
279+
</tr>
280+
<tr>
281+
<td><code>selectric-highlight</code></td>
282+
<td>Fired when a select option is highlighted</td>
283+
</tr>
284+
<tr>
285+
<td><code>selectric-before-select</code></td>
286+
<td>Fired before a select option is selected</td>
287+
</tr>
288+
<tr>
289+
<td><code>selectric-select</code></td>
290+
<td>Fired before a select option is selected</td>
291+
</tr>
266292
<tr>
267293
<td><code>selectric-before-change</code></td>
268294
<td>Fired before select options change</td>
@@ -279,7 +305,7 @@ $('select').on('eventname', function(element){
279305

280306
##Hooks:
281307

282-
Check [jquery.selectric.placeholder.js](plugins/jquery.selectric.placeholder.js) source for a usage example
308+
Check [jquery.selectric.placeholder.js](plugins/jquery.selectric.placeholder.js) source for a usage example.
283309

284310
```js
285311
// Add a callback everytime 'callbackName' is called

0 commit comments

Comments
 (0)