/ng-onoff

Angular component used to integrate the original game onoff

Primary LanguageTypeScriptMIT LicenseMIT

Angular Component OnOff

CircleCI npm version License

This is an angular module that can be helped to integrate the original game OnOff

Versioning

This project uses the following version rules:

X.Y.Z

Where :

  • X is the major version of Angular supported by this project
  • Y is the major version of this library. Be careful with this rule, you can have some breaking changes between two Y number.
  • Z is the minor version of this library. It will be increased when there are some bug fixes.

Supported Version

Angular Version Support Branch
>= 8.0 master

Installation

npm install ng-onoff --save

Usage

First import NgOnOffModule in the module where you wish to display the game (it can be another module than the AppModule)

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';
import { NgOnoffModule } from 'ng-onoff';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    NgOnoffModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

And then use the component in a container that suits you :)

<div style="height: 100vh">
  <ng-onoff></ng-onoff>
</div>

Contributions

Any contribution or suggestion would be really appreciated. Feel free to use the Issue section or to send a pull request.

Development

The repository provide a light demo to play with the onOff component and to try an integration with angular material.

License

The MIT License (MIT)

Copyright (c) 2019 Augustin Husson