This package has been deprecated

Author message:

zzz

nms-ui-switch

2.0.0 • Public • Published

Ngx UI Switch Component

Greenkeeper badge Gitter Build Status npm version npm All Contributors Throughput Graph

Description

This is a simple iOS 7 style switch component for Angular4.

Live demo

alt

Inspired by switchery - in angular4.

Installation

npm install ngx-ui-switch --save

Usage

import { UiSwitchModule } from 'ngx-ui-switch';
import { AppComponent } from './app.component';

@NgModule({
  imports: [BrowserModule, FormsModule, UiSwitchModule],
  declarations: [AppComponent],
  bootstrap: [AppComponent]
})
export class AppModule {
}
<ui-switch></ui-switch>

Two way binding

<ui-switch [(ngModel)]="enable"></ui-switch>

Params

checked

type: boolean

default: false

<ui-switch checked></ui-switch>
<ui-switch [checked]="false"></ui-switch>

disabled

type: boolean

default: false

<ui-switch disabled></ui-switch>
<ui-switch checked [disabled]="true"></ui-switch>

change

type: event

default: noop

<ui-switch (change)="onChange($event)"></ui-switch>

size

type: string

default: medium

<ui-switch size="small"></ui-switch>
<ui-switch size="large"></ui-switch>

reverse

type: boolean

default: false

<ui-switch reverse></ui-switch>

color

type: string

default: rgb(100, 189, 99)

<ui-switch color="red"></ui-switch>

switchColor

type: string

default: #fff

<ui-switch switchColor="#fcfcfc"></ui-switch>

defaultBgColor

Default background color

type: string

default: #fff

<ui-switch defaultBgColor="red"></ui-switch>

defaultBoColor

Default border color

type: string

default: #dfdfdf

<ui-switch defaultBoColor="black"></ui-switch>

Development

Setup

yarn install

Demo

Edit files in src/app to add to the demo or try changes to the library.

Build library

First, edit version in package.json and src/lib/package.json to publish a new version to npmjs.org

# Build the library into dist/{es5,es2015}
yarn build
# Publish to npm
yarn run publish

Contributors

Thanks goes to these wonderful people (emoji key):


webcat_black

💻 🎨 💡 🤔 👀

Chris McKnight

💬 💻 📖 🤔 🚇 🔌 👀 🔧

This project follows the all-contributors specification. Contributions of any kind welcome!

FAQ

License

MIT

Package Sidebar

Install

npm i nms-ui-switch

Weekly Downloads

0

Version

2.0.0

License

MIT

Last publish

Collaborators

  • ssaso