Ember-cli-selectize
An Ember and Selectize integration, packaged as an Ember-cli addon. Check Selectize and Ember-cli!
Demo
Check (old demo): http://miguelcobain.github.io/ember-selectize
Browser Support
Should run wherever Ember and Selectize run.
Installation
As an Ember CLI addon
Run either command below depending on Ember version in your project folder.
For Ember CLI >= 0.2.3
:
ember install ember-cli-selectize
For Ember CLI < 0.2.3
:
ember install:addon ember-cli-selectize
Usage
This addon provides an ember-selectize
component.
Its usage should be very similar to Ember.Select
, but with additional features.
Properties
content
- Array containing all the options to select fromselection
- Ember-selectize will set this property to the selection that was made. Usually some property on a model, for example. Ifmultiple
istrue
, then it should be an array.value
- Ember-selectize will set this property to the value of the selection that was made. It is not currently supported in multiple selection mode.optionValuePath
- Selectize requires a unique hash for each option available. Set this to a path to such a property on your options. Prefix withcontent.
. Example:content.id
optionLabelPath
- Set this to a path where selectize can get a label for display. Computed properties are many times useful for this. If Ember-selectize detects a "falsy" value, it will use an empty string. Example:content.name
plugins
- Set this to a comma delimited list of selectize plugins to override the default plugin selection (currently remove_button). Note, not all plugins have been tested to work with ember-cli-selectize, YMMV. Example:restore_on_backspace,drag_drop
placeholder
orprompt
- Set any of these to display a text when there is no choice made. Example"Please select an- option"
disabled
- Iftrue
disables changes in selectizemultiple
- Iftrue
ember-selectize will enter multiple mode.selection
is an array of options.sortField
- Pass a string of a property to sort by. You can also pass an array of objects[{ field: 'someProperty', direction: 'asc' }, {/*...*/}]
. See selectize usage for details. Example:"name"
sortDirection
- IfsortField
is a string, specify the direction. Example:"asc"
or"desc"
. This is ignored ifsortField
is an array (you can specify direction inside that array).filter
- This property will have the text that the user entered to filter options. Useful for searching options in server from a large set.loading
- Whentrue
ember-selectize adds a loading class to selectize wrapper. Just like selectize does. Then you can customize. Useful with async relationships or "finds" in Ember-Data:loading=types.isPending
.optionFunction
,itemFunction
,optionCreateFunction
,optgroupHeaderFunction
,optgroupFunction
- Will be called on the component with two parametersdata
andescape
.escape
is a function to escape text. These functions are expected to build the desired html and return it as a string. These functions take precedence over their*Template
and*View
counterparts.optionTemplate
,itemTemplate
,optionCreateTemplate
,optgroupHeaderTemplate
,optgroupTemplate
optionView
,itemView
,optionCreateView
,optgroupHeaderView
andoptgroupView
- Render using templates or views! View takes precedence over template, so if you do strange things like setting optionView and optionTemplate, the latter will be ignored. Might not work with all Ember versions. This is delicate. Check this issue.required
- Iftrue
addsrequired
attribute
ember-selectize also supports selectize's general options, excluding options
and items
(equivalent to content
and selection
respectively).
Actions
Ember is moving towards a paradigm that encourages the use of actions. With this in mind, ember selectize provides a set of actions. The goal is to not use two way data bindings, that is, you pass the data to your components, but the components send actions up to let you (and only you) change the data. Here are the actions the ember selectize supports:
create-item
- sent when the user creates a tag. The text is sent as a parameter.update-filter
- sent when the user types in the input element (functional equivalent of observingfilter
property)select-item
- sent when the user selects an item (functional equivalent of observingselection
property). The selected object is sent as a parameter. When the user deselects the option, parameter isnull
.add-item
- sent when the user selects an item in multiple mode. The added object is sent as a parameter.remove-item
- sent when the user deselects an item in multiple mode. The removed object is sent as a parameter.
Ember selectize supports both APIs.
More info:
- ember-selectize registers observers on object labels. This is great because if you change the label property anywhere in your application, selectize labels will also update.
Theme customization
You can customize which theme to use in your Brocfile.
//your-app/Brocfile.js
var EmberApp = require('ember-cli/lib/broccoli/ember-app');
var app = new EmberApp({
'ember-cli-selectize': {
//valid values are `default`, `bootstrap2`, `bootstrap3` or false
'theme': 'bootstrap3'
}
});
module.exports = app.toTree();
If you want to use the default theme, you don't need to specify any option.
If you don't want to include any css at all for some reason, simply assign false
or any "falsy" value to the theme
option.
Running
ember server
- Visit your app at http://localhost:4200.
Running Tests
ember test
ember test --server
Selectize
's tests assures that everything is ok between Selectize<->DOM.
Ember.Select
's tests also test the DOM. This is unecessary in this project.
Ember-selectize tests should be focused between Ember<->Selectize.
Building
ember build
For more information on using ember-cli, visit http://www.ember-cli.com/.