ngx-loading-customizer
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.1 • Public • Published

    Angular Loading Customizer

    License Build codecov Version

    Angular Loading Customizer is a library that helps you represent and show data that needs to be loaded from a backend and can therefore be in a loading state.

    • Loadable type - The type Loadable<T> lets you represent the full state of your loading data with a single object. No more additional booleans passed to your components.
    • Loadable component - The component ld-loadable shows your loaded data, a loading animation or an error state depending on the state of the loadable object.
    • Global defaults - You can define a default custom loading animation and a default custom error state globally per lazy-loaded module. Once you want to refine the individual loading animations per loaded data, you can simply define local loading animations that overrule the default.
    • Observable and NgRx Compatibility - Both the loadable type and loadable component integrate well with observables and NgRx. Via the operator toLoadable a loadable can be extracted from an observable.
    • No dependencies — Besides Angular this library does not have any dependencies.

    Installation

    npm install --save ngx-loading-customizer
    

    Try it

    This repo includes an example application showcasing the usage of ngx-loading-customizer.

    It is hosted at https://fboeller.github.io/ngx-loading-customizer.

    You can also work with it locally:

    $ git clone https://github.com/fboeller/ngx-loading-customizer.git
    $ cd ngx-loading-customizer
    $ npm install
    $ npm start example-app
    

    Usage

    Construct a loadable

    Given an observable, you can construct a loadable with the operator toLoadable.

    import { toLoadable } from "ngx-loading-customizer";
    import { of } from "rxjs";
    
    const loadable$ = of({ id: 42 }).pipe(toLoadable);

    Display a loadable

    If you have an object of type Loadable<T>, you can display it with the ld-loadable component.

    First, make sure to import the LoadingCustomizerModule in your module.

    import { NgModule } from "@angular/core";
    import { LoadingCustomizerModule } from "ngx-loading-customizer";
    import { CommonModule } from "@angular/common";
    
    @NgModule({
      imports: [LoadingCustomizerModule],
    })
    export class AppModule {}

    Define a loadable object in your component. You can use idle, loading, loaded('value') and errored('error') to construct a loadable.

    import { Component } from "@angular/core";
    import { idle, Loadable } from "ngx-loading-customizer";
    
    @Component({
      selector: "app-some",
      templateUrl: "./some.component.html",
    })
    export class SomeComponent {
      loadable: Loadable<object> = idle;
    }

    Then, you can display the loadable by passing it as input to the ld-loadable component and by defining the template for the loaded state. With the pipe loadedValue you can extract the loaded value from the loadable.

    <ld-loadable [loadable]="loadable">
      <p>Loaded</p>
      <pre>{{ loadable | loadedValue | json }}</pre>
    </ld-loadable>

    Note that this inner template is only rendered in the loaded state and this example defaults to the standard loading animation and error state.

    Define a custom default loading animation

    You can define a custom default loading animation within your application. Note that the way Angular providers work, these defaults are global within your lazy-loaded module.

    Create your custom loading animation component and pass it to the LoadingCustomizerModule. Each ld-loadable component now defaults to this loading animation component.

    import { NgModule } from "@angular/core";
    import { LoadingCustomizerModule } from "ngx-loading-customizer";
    import { CustomLoadingAnimationComponent } from "./custom-loading-animation.component";
    
    @NgModule({
      declarations: [CustomLoadingAnimationComponent],
      imports: [
        LoadingCustomizerModule.forRoot({
          defaultComponents: {
            loading: CustomLoadingAnimationComponent,
          },
        }),
      ],
    })
    export class AppModule {}

    Note that you can use the same mechanism to change the default error state. However, the component you define for that needs to define an input error accepting any type.

    Define a custom local loading animation

    In cases where you would like to refine the loading animation for the concrete usage of an ld-loadable, you can define and pass a loading template to the component.

    <ld-loadable [loadable]="loadable" [templates]="{ loading: loading }">
      <h3>Loaded</h3>
      <pre>{{ loadable | loadedValue | json }}</pre>
    </ld-loadable>
    <ng-template #loading>
      <p>The answer is currently being computed.</p>
    </ng-template>

    Define a custom error state

    To display a custom error state, you can use the same mechanism as for custom loading animation. The template of a custom error state can optionally accept and display the error.

    <ld-loadable [loadable]="loadable" [templates]="{ error: error }">
      <h3>Loaded</h3>
      <pre>{{ loadable | loadedValue | json }}</pre>
    </ld-loadable>
    <ng-template #error let-error="error">
      <p>There has been an error: {{ error | json }}</p>
    </ng-template>

    Change the presentation of the idle state

    A loadable is in the idle state before any loading has started. In this state, the ld-loadable component does not render anything by default, leading to a white page. In case you would like to show a loading animation immediately, you can change the default behavior.

    import { NgModule } from "@angular/core";
    import { LoadingCustomizerModule } from "ngx-loading-customizer";
    import { LoadableLoadingComponent } from "ngx-loading-customizer";
    
    @NgModule({
      imports: [
        LoadingCustomizerModule.forRoot({
          defaultComponents: {
            idle: LoadableLoadingComponent,
          },
        }),
      ],
    })
    export class AppModule {}

    Transform a loadable

    A loadable is a functional data structure. It defines some utility functions to work with it.

    If you have a loadable and want to change its value once it is loaded, you can use map.

    import { map, loaded } from "ngx-loading-customizer";
    const loadable = loaded(5);
    const result = map((x) => x + 10, loadable); // loaded(15)

    If you have a loadable and want to map it to another loadable once it is loaded, you can use flatMap.

    import { flatMap, loaded } from "ngx-loading-customizer";
    const loadable = loaded(5);
    const result = flatMap((x) => loaded(x + 10), loadable); // loaded(15)

    Install

    npm i ngx-loading-customizer

    DownloadsWeekly Downloads

    1

    Version

    0.1.1

    License

    MIT

    Unpacked Size

    210 kB

    Total Files

    52

    Last publish

    Collaborators

    • fboeller