Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 3.69 KB

README.md

File metadata and controls

72 lines (50 loc) · 3.69 KB

Build Status

servrox's AnimationsLib

Fancy angular library containing easy to use and customizable animation elements.

Info: See travis ci script to know how to build this lib-only-repo locally.

Live Demo

Getting Started

1. Install

npm i @servrox/animations-lib

2. Import module (e.g. OverlayModule)

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { OverlayModule } from '@servrox/animations-lib';


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

3. Use in template (e.g. OverlayModule -> every input variable is optional)

<ss-ani-lib-overlay
    *ngIf="<boolean>"
    [count]="<number>"
    [useRandomColor]="<boolean>"
    [speed]="<number>"
    [logo]="<string>">
</ss-ani-lib-overlay>

or

<ss-ani-lib-overlay></ss-ani-lib-overlay>

Defaults for OverlayModule:

count: number = 20,
useRandomColor: boolean = true,
speed: number = 1600,
logo: string

Built With

Authors