Skip to content

revoxltd/ngx-ios-toggle

Repository files navigation

Pages iOS Toggle

Build Status codecov npm version devDependency Status GitHub issues GitHub stars GitHub license

Demo

https://revoxltd.github.io/pg-ios-toggle/

Table of contents

About

iOS inspired toggle for Angular 5 / 6

Installation

Install through npm:

npm install --save ngx-ios-toggle

Then include in your apps module:

import { NgModule } from '@angular/core';
import { IosToggleModule } from 'ngx-ios-toggle';

@NgModule({
  imports: [
    IosToggleModule.forRoot()
  ]
})
export class MyModule {}

Finally use in one of your apps components:

import { Component } from '@angular/core';

@Component({
  template: '<hello-world></hello-world>'
})
export class MyComponent {}

You may also find it useful to view the demo source.

Documentation

All documentation is auto-generated from the source via compodoc and can be viewed here: https://revoxltd.github.io/pg-ios-toggle/docs/

Development

Prepare your environment

  • Install Node.js and NPM
  • Install local dev dependencies: npm install while current directory is this repo

Development server

Run npm start to start a development server on port 8000 with auto reload + tests.

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Release

  • Bump the version in package.json (once the module hits 1.0 this will become automatic)
npm run release

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published