fng-ui-select

Plugin for forms-angular that adds ui-select (https://github.com/angular-ui/ui-select) support.

Usage

npm install fng-ui-select

To get all the dependencies at the top level of your node_modules run

npm dedupe

Add the following lines to your index.html (or equivalent) file.

<link rel="stylesheet" href="angular-ui-select/dist/select.css">
<script src="angular-ui-select/dist/select.js"></script>
<script src="fng-ui-select/fng-ui-select.js"></script>

In your Mongoose schemas you can set up fields like this:

colour: {type: String, enum: ['Blue', 'Brown', 'Green', 'Hazel'], form: {directive: 'fng-ui-select'}}
lookup: {type: Schema.Types.ObjectId, ref: 'anotherModel', form: {directive: 'fng-ui-select'}},

Options can be added to a fngUiSelect object within the form object as follows:

• theme defaults to select2. Other options are bootstrap and selectize. Bootstrap required Bootstrap 3 and will fall back to select2.
• fngAjax creates a control that queries the back end after each keystroke (with 100ms of debounce) for matches.
  • Set to true to search the whole of the ref collection (honouring any collection level filters)
  • Assign a string starting with '/' to do your own query on the backend. The search string will be in req.query.q and the current value of the existing record in req.query.e. The $index will be in req.query.i.
  • Use a mongo search object (converted to JSON and escaped) to apply a filter to the default search over ref collection. For example to search only amongst records where the value of accountSuspended is false you might do

    customer: {
      type: Schema.Types.ObjectId
      ref: 'customer', 
      form: {
        directive: 'fng-ui-select',
        fngUiSelect: {
          fngAjax: escape(JSON.stringify( {accountSuspended:false} ))
        } 
      }
    }

The text property of the result set will be used to populate the options, unless the additional option is used, in which case anything in the additional property will be concatenated to the text. This will be empty unless you are overriding the default search behaviour.

• forceMultiple when set to true on an array schema element will create multiple controls, rather than a single control accepting multiple selections
• deriveOptions a name of a function on the form scope that returns a property name on the scope that contains the options. If these options will be in the form of objects which include an id and a text property you create a property isObjects on the specified form scope property with the value true.
• additional appends the contents of the additional property (if any) in the result set from the lookup function
• noconvert inhibits the options being passed to forms-angular, so no automatic lookups are performed (sometimes useful when using fng-ui-select in a directive on a forms-angular form.

Tests

e2e tests require the forms-angular website (https://github.com/forms-angular/website)