0.0.1 • Published 6 years ago

ngx-snowf v0.0.1

Weekly downloads
17
License
MIT
Repository
github
Last release
6 years ago

ngx-snowf

Snowfall component for Angular2+ -- Let it snow on your page! ❄

npm.io

Install

npm:

npm install ngx-snowf --save

Usage

add SnowfModule to NgModule

import { SnowfModule } from 'ngx-snowf';

@NgModule({
    imports: [
        SnowfModule
    ]
})

use snowf component in template

<Snowf
  [amount]="50"
  [size]="5"
  [speed]="1.5"
  [wind]="0"
  [color]="'#fff'"
  [opacity]="0.8"
  [swing]="1"
  [image]=""
  [zIndex]=""
/>

Default Options

ArgumentTypeDefault ValueDescription
amountNumber50Number of snowflakes displayed at a time.
sizeNumber5Size of snowflakes.
speedNumber1.5Vertical speed of snowflakes. The larger, the snowflakes drop faster.
windNumber0Horizontal wind power. Wind will blow right if this is a positive number, and a negative number makes wind blow left.
colorString'#fff'Color of snowflakes. This option accepts HEX or RGB color code, such as "#fff", "#ffffff", "rgb(255,255,255)".
opacityNumber0.8The max opacity of snowflakes. The plugin will generate snowflakes with different opacity from 0 to this number.
swingNumber1Swing offset of snowflakes. If you don't want them to swing, set this option as 0.
imageStringnullSet this option to replace the snowflake with your image.
zIndexNumbernullPosition of the canvas layer. Set the layer front or back by changing this value.

Others

snowf (use snowf with Vanilla JS)

react-snowf (use snowf with React)

vue-snowf (use snowf with Vue)

Licence

ngx-snowf is open source and released under the MIT Licence.

Copyright (c) 2017 Fuxy526