0.0.3 • Published 5 years ago

ngx-bootstrap-switch v0.0.3

Weekly downloads
120
License
MIT
Repository
github
Last release
5 years ago

npm version gzip bundle size

Angular Bootstrap Switch (ngx-bootstrap-switch)

This is a Angular 4 Component to add a switch like input. It's basically an Angular 4 port for this: Bootstrap-Switch. Compatibility with angular 4.x - 7.x

See Demo


Installation

$ npm install --save ngx-bootstrap-switch

Install animations package:

$ npm install @angular/animations --save

Then, add it to your app.module

...
import { NgxBootstrapSwitchModule } from 'ngx-bootstrap-switch';
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';

@NgModule({
  imports: [
    ...
    NgxBootstrapSwitchModule.forRoot(),
    BrowserAnimationsModule
  ],
  declarations: [
    ...
  ],
  bootstrap: [ AppComponent ]
})
export class AppModule { }

For styling purposes, you should add the Bootstrap stylesheet to your index.html

<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">

Usage

In your component template you just need to add the component with the bindings you want. Like this:

<ngx-switch [status]="value"
            [onText]="onText"
            [offText]="offText"
            [onColor]="onColor"
            [offColor]="offColor"
            [size]="size"
            [disabled]="disabled"
            (statusChange)="onFlagChange($event)">
</ngx-switch>

All the attributes are optional.

API

Inputs

InputTypeDefaultRequiredDescription
statusbooleanfalsenoThe current status of the switch (true,false). This is a two way binding
onTextstringOnnoThe text to show on the ON label of the switch
offTextstringOffnoThe text to show on the OFF label of the switch
onColorstringgreennoThe color of the ON label of the switch (blue,default,gray,green,red,sky-blue,yellow)
offColorstringrednoThe color of the OFF label of the switch (blue,default,gray,green,red,sky-blue,yellow)
sizestringnormalnoThe size of the switch (mini,small,normal,large)
disabledbooleanfalsenoBoolean value to enable/disabled the switch

Outputs

OutputDescription
(statusChange)Event fired on status change