Skip to content

v3.0.0

Latest
Compare
Choose a tag to compare
@tinesoft tinesoft released this 25 Sep 23:29
· 6 commits to master since this release

Chores

  • core: rename the project into ngx-scrollreveal (f4c4d1a)

Features

  • core: migrate to ScrollReveal v4.x.x (7b3c816)
  • core: remove the forRoot() in NgsRevealModule (no longer needed with Angular 6) (b708dec)
  • core: update to Angular v6.x.x and higher (54c8a0a)

BREAKING CHANGES

  • core: imports in your application must be updated to consider the new package name ngx-scrollreveal

Before:

npm install --save ng-scrollreveal

...

import { ... } from 'ng-scrollreveal';

After:

npm install --save ngx-scrollreveal

...

import { ... } from 'ngx-scrollreveal';
  • core: NgsRevealModule.forRoot() has been removed, and internally replaced by use of new providedIn option in @Injectable

Before:

import {NgsRevealModule} from 'ng-scrollreveal';

@NgModule({
  declarations: [AppComponent, ...],
  imports: [NgsRevealModule.forRoot()],
  bootstrap: [AppComponent]
})
export class AppModule {
}

After:

import {NgsRevealModule} from 'ng-scrollreveal';

@NgModule({
  declarations: [AppComponent, ...],
  imports: [NgsRevealModule],
  bootstrap: [AppComponent]
})
export class AppModule {
}
  • core: migration to ScrollReveal v4.x.x brings some breaking changes to be addressed
  • @types/scrollreveal is no longer necessary and must be removed from your package.son
  • options.distance now only supports em, px and % values
  • NgsRevealConfig default values have been updated to match ScrollReveal's
  • be aware that ScrollReveal now requires a commercial license, unless for GPL-3.0 compatible open source projects.