deblan-mirror/Choices
deblan-mirror/Choices
1
0
Fork 0
mirror of https://github.com/Choices-js/Choices.git synced 2024-06-03 06:22:25 +02:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Josh Johnson 2016-07-03 10:54:20 +01:00 committed by GitHub
parent 6c753b1078
commit 736dbb870b
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -6,17 +6,17 @@ A lightweight, configurable select box/text input plugin. Similar to Select2 and
<script src="/assets/js/dist/choices.min.js"></script> <script src="/assets/js/dist/choices.min.js"></script>
<script> <script>
// Pass multiple elements: // Pass multiple elements:
var choices = new Choices(elements); const choices = new Choices(elements);
// Pass single element: // Pass single element:
var choice = new Choices(element); const choice = new Choices(element);
// Pass reference // Pass reference
var choice = new Choices('[data-choice']); const choice = new Choices('[data-choice']);
var choice = new Choices('.js-choice'); const choice = new Choices('.js-choice');
// Passing options (with default options) // Passing options (with default options)
var choices = new Choices(elements, { const choices = new Choices(elements, {
items: [], items: [],
maxItemCount: -1, maxItemCount: -1,
addItems: true, addItems: true,
@ -76,7 +76,7 @@ To install via NPM, run `npm install --save-dev choices.js`
| Group | A group is a collection of choices. A group should be seen as equivalent to a `<optgroup></optgroup>` element within a select input.| | Group | A group is a collection of choices. A group should be seen as equivalent to a `<optgroup></optgroup>` element within a select input.|
| Item | An item is an inputted value (text input) or a selected choice (select element). In the context of a select element, an item is equivelent to a selected option element: `<option value="Hello" selected></option>` whereas in the context of a text input an item is equivelant to `<input type="text" value="Hello">`| | Item | An item is an inputted value (text input) or a selected choice (select element). In the context of a select element, an item is equivelent to a selected option element: `<option value="Hello" selected></option>` whereas in the context of a text input an item is equivelant to `<input type="text" value="Hello">`|
## Options ## Configuration options
### items ### items
<strong>Type:</strong> <strong>Default:</strong> `[]` <strong>Type:</strong> <strong>Default:</strong> `[]`