rfx-scroll-animation v3.5.4

RfxScrollAnimation

Animate your page elements on scroll

Features

• Animate your component on scroll
• Multiple animations
• Apply directly on your element
• Add your own custom animation
• Best performance with will-change

Installation

Install the npm package:

npm install rfx-scroll-animation

Import module:

import { RfxScrollAnimationModule } from 'rfx-scroll-animation';

@NgModule({
  imports: [
    RfxScrollAnimationModule
  ]
})

Initialize scroll animations

In your app.component.ts initialize animation listeners inside ngAfterViewInit WARNING: *use ngAfterViewInit instead of ngOnInit otherwise you may experience glitches on page loading

import { RfxScrollAnimationService } from 'rfx-scroll-animation';

constructor(private rfxScrollAnimationService: RfxScrollAnimationService) { }

public ngAfterViewInit(): void {
  this.rfxScrollAnimationService.initListeners();
}

and if you have a custom scrollbar component you can pass the nativeElement to the initListeners() function like this: WARNING: *use ngAfterViewInit instead of ngOnInit otherwise you may experience glitches on page loading

<custom-scrollbar #scrollbar>
  <!-- Your page here -->
</custom-scrollbar>

@ViewChild('scrollbar')
public scrollbarElement: ElementRef;

public ngAfterViewInit(): void {
  this.rfxParallaxService.initListeners(this.scrollbarElement.nativeElement);
}

Usage

just apply libRfxScrollAnimation to your container and set animation type

<div libRfxScrollAnimation animationType="bottom">
  [...]
</div>

Configuration

distanceFromPageBottomPercentage: number

(default value: 20) when element should appear - in percentage from the bottom of the page (e.g. 20 = 20% of current viewport from the bottom)

animationType: AnimationTypeEnum

(default value: 'none') Available animation types:

• none - use this if you want to implement a custom animation
• top - fade in from top
• bottom - fade in from bottom
• right - fade in from right
• left - fade in from left
• zoom - zoom in / out

animationDistancePx: number

(default value: 25) from how far the animation should fade in - shift value

transitionDurationMs: number

(default value: 500) animation duration in milliseconds

transitionDelayMs: number

(default value: 0) animation delay in milliseconds

transitionTimingFunction: string

(default value: 'cubic-bezier(0.4, 0.0, 0.2, 1)') transition timing function (for more info see https://www.w3schools.com/cssref/css3_pr_transition-timing-function.asp)

scaleRatio: number

(default value: 1.5) ONLY FOR 'zoom' ANIMATION TYPE! scale value (eg. scale from value to 1)

isOnlyFirstTime: boolean

(default value: true) animate only on first scroll (true) or always (false)

elementVisibleChange: EventEmitter<boolean>

listen to show / hide element events and create your own custom animation

<div libRfxScrollAnimation animationType="bottom" (elementVisibleChange)="myCustomFunction($event)">
  [...]
</div>

Demo

You can view all available demos here: https://demo.redfoxxo.dev/

License

This project is licensed under the MIT License