Awesome
<h1>Angular Scroll Animations</h1> <div>
Table of contents
<br/>About
This minimalistic Angular directive, free from external dependencies, empowers you to effortlessly implement CSS animations on elements. These animations trigger when an element comes into view through scrolling on the page. It seamlessly integrates with your choice of CSS animations.
<br/>Getting started
Installation
npm install ngx-scroll-animations
Optionally include prebuilt animations
/* angular-cli file: src/styles.css */
@import "node_modules/ngx-scroll-animations/styles/animations.min.css";
Import the directive
import { Component } from '@angular/core';
import { NgxScrollAnimationsDirective } from 'ngx-scroll-animations';
@Component({
selector: 'app-root',
standalone: true,
templateUrl: './app.component.html',
styleUrl: './app.component.scss',
imports: [ NgxScrollAnimationsDirective ],
})
export class AppComponent {}
Optional Global Configs
Add provideNgxScrollAnimations to your app.config.ts file as shown below.
export const appConfig: ApplicationConfig = {
providers: [
provideRouter(routes),
provideClientHydration(),
/// Add the code below
provideNgxScrollAnimations({
speed: 300,
animationName: 'fade-in',
once: false,
/// Other configs...
}),
],
};
Inputs
| Option | Type | Default | Comment |
|---|---|---|---|
| ngxScrollAnimate | string | fade-in-up | Name of the animation (as example 'fade-in') |
| zoneless | boolean | true | Set this property to false if your application runs with ng zone. |
| easing | string | ease | Defines how the animation accelerates and decelerates during its runtime. |
| speed | number | 300 | The speed at which the animation runs in milliseconds. |
| delay | number | 0 | Delays the start of the animation. Accepts the delay time in milliseconds. |
| aos | number | 0.8 (when thresholdMode is set to 'pixel', the value is 20) | The threshold for triggering the animation when an element scrolls into the viewport. |
| thresholdMode | 'percent' / 'pixel' | percent | Defines the mode for calculating the threshold: 'percent' or 'pixel'. |
| once | boolean | true | If true, triggers the animation only once when the element scrolls into the viewport. |
| disabled | boolean | false | A boolean value to enable or disable the animation. |
Outputs
| Option | Type | Comment |
|---|---|---|
| startAnimation | EventEmitter<void> | Emits an event at the start of the animation. |
| endAnimation | EventEmitter<void> | Emits an event at the end of the animation. |
Prebuild animations
'fade-in''fade-in-right''fade-in-left''fade-in-up''fade-in-up-scale''fade-in-down''slide-in-up''scale-in''bounce''rotate'
Simple example
<img
ngxScrollAnimate
src="https://picsum.photos/300"
alt="demo-image"
/>
Complete example demonstrating all properties
<img
ngxScrollAnimate="fade-in-up"
easing="ease"
speed="300"
delay="0"
aos="0.8"
thresholdMode="percent"
once="true"
disabled="false"
(endAnimation)="endAnimation()"
(startAnimation)="startAnimation()"
src="https://picsum.photos/300"
alt="demo-image"
/>
Custom animation
@keyframes my-special-animation {
from {
opacity: 0;
background: red;
}
to {
opacity: 1;
background: blue;
}
}
<img
ngxScrollAnimate="my-special-animation"
src="https://picsum.photos/300"
speed="2000"
alt="demo-image"
/>
Contributing
I welcome contributions from the open-source community to make this project even better. Whether you want to report a bug, suggest a new feature, or contribute code, I appreciate your help.
Bug Reports and Feature Requests
If you encounter a bug or have an idea for a new feature, please open an issue on my GitHub Issues page. I will review it and discuss the best approach to address it.
Code Contributions
If you'd like to contribute code to this project, please follow these steps:
- Fork the repository to your GitHub account.
- Clone your forked repository to your local machine.
git clone https://github.com/hm21/ngx-scroll-animations.git