https://github.com/nexucis/ng-onoff

Angular component used to integrate the original game onoff
https://github.com/nexucis/ng-onoff

Last synced: 9 days ago
JSON representation

Angular component used to integrate the original game onoff

• Host: GitHub
• URL: https://github.com/nexucis/ng-onoff
• Owner: Nexucis
• License: mit
• Created: 2019-09-14T07:58:15.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-17T19:55:44.000Z (about 2 months ago)
• Last Synced: 2024-09-18T18:56:08.745Z (about 2 months ago)
• Language: TypeScript
• Homepage:
• Size: 4.26 MB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Angular Component OnOff

[![CircleCI](https://circleci.com/gh/Nexucis/ng-onoff.svg?style=shield)](https://circleci.com/gh/Nexucis/ng-onoff) [![npm version](https://badge.fury.io/js/ng-onoff.svg)](https://badge.fury.io/js/ng-onoff) [![License](https://img.shields.io/:license-mit-blue.svg)](LICENSE.md)

This is an angular module that can be helped to integrate the original game [OnOff](https://github.com/starzonmyarmz/js13k-2018)

### 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

```bash

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)

```typescript

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 :)

```html



  



```

## 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](./LICENSE))

Copyright (c) 2019 Augustin Husson