ngx-party-parrots
Version:
This gonna be easter egg library
81 lines (65 loc) • 2.6 kB
Markdown
# ngx-party-parrots 
## Description 
Angular 7 easter egg components!
## Demo 
https://raddko15.github.io/ngx-party-parrots/
## Installation 
```
npm i ngx-party-parrots
```
## Basic usage 
The usage consists in three steps.
* Install the library - covered in "Installation" paragraph
* Import NgxPartyParrotsModule to the main module of your app or choose the one where it should be used.
```
imports: [
NgxPartyParrotsModule
],
```
* Use components in your application
The simpliest usage:
```
<ngx-pp-party-parrots
mode="default"
></ngx-pp-party-parrots>
```
## Recommended usage 
In your component.ts create the variable and function
```
isPartyParrotRainVisible = false;
onPPCodeProvided() {
this.isPartyParrotRainVisible = !this.isPartyParrotRainVisible;
}
```
In your component.html use two party-parrots components
```
<ngx-pp-code-detector (codeProvided)="onPPCodeProvided()"></ngx-pp-code-detector>
<ngx-pp-party-parrots mode="default"></ngx-pp-party-parrots>
```
Run your application - parrots are hidden.
Type "parrots" - to display parrots and to hide them - yay you have the easter egg embedded in your app!
## Customization 
There are two ways of modifying components - by choosing mode or by sending custom props!
You can also mix both ways :))
Modes:
```
mode="default"
mdoe="one"
mode="love"
mode="skiing" // recommended only for bright/white backgrounds
mode="snowing"
mode="copsAndSpies"
```
Props:
```
@Input() parrotsAmount: number;
@Input() opacity: number; // 0.1 - 1
@Input() parrotsData: ParrotModel[];
@Input() speed: { min: number, max: number };
@Input() skiingMode: string; // yes/no
@Input() slalomLength: { min: number, max: number };
```
## Contributors 
raddko15,
proxeld,
bulbulator