0.0.0 • Published 2 years ago

ngx-selectizes v0.0.0

Weekly downloads
24
License
-
Repository
-
Last release
2 years ago

ngx-selectizes

npm version

Angular 10 is available component for selectize.js

Including within existing angular-cli project

  1. npm i --save ngx-selectizes jquery selectize
  2. Add the following to the styles array within .angular.json:
    "../node_modules/selectize/dist/css/selectize.css",
    "../node_modules/selectize/dist/css/selectize.{your chosen theme}.css"
  3. Add the following to the scripts array within .angular.json
    "../node_modules/jquery/dist/jquery.min.js",
    "../node_modules/ngx-selectizes/selectize/selectize.standalone.js" (or take from /node_modules/selectize/...)
  4. Import module within applicable @NgModule:
    import {NgSelectizeModule} from 'ngx-selectizes';
    imports: [..., NgSelectizeModule, ...],
  5. Use within template: <ng-selectize [config]="..." [options] = "..." {other-attributes}></ng-selectize>

Docs

The docs directory within this repo is the result of ng build --prod from the ng-selectize-demo repository. It can be accessed from the hosted example site above.

Attributes

AttributeTypeDefaultDescriptionImplemented
configObjectnullSelectize configYes
optionsArraynullAvailable options to select fromYes
placeholderString''Placeholder text to be displayed. Is overridden if hasOptionsPlaceholder/noOptionsPlaceholder are non-nullYes
noOptionsPlaceholderString''Placeholder text to be displayed when no options are availableYes
hasOptionsPlaceholderString''Placeholder text to be displayed when options are availableYes
enabledBooleantrueEnables the input field when true, disabled otherwiseYes
formControlFormControlnullForm control field to be used to set value and/or validation.Yes
errorClassString'has-error'CSS Class to be added to the field whenYes
optionGroupsObjectnullOrganize options within groupsYes

Included Selectize Plugins

NameOptionsDescription
dropdown_direction{'auto', 'up', 'down'}Control the direction in which the dropdown opens.