README.md

November 24, 2020 ยท View on GitHub

NG Shimmer - Content Placeholder

angular License: Apache License 2.0 Twitter: Adithya Sreyaj

Shimmer Animation for Angular Applications

Angular Remix Icon

Simple and easy to user Shimmer Animation placeholder for your Angular applications. An application should be having a good User Experience inorder to succeed. Smaller things like adding a shimmer animation to let the users know that something is being loaded is a great way to improve the application's UX.

User Ratings Card

Profile Card

Features

  • Simple and Easy to Setup
  • Ease to use
  • CSS based super light
  • Zero Dependencies
  • Customizable

How to Use the Component

Install the package using the command:

npm i @sreyaj/ng-shimmer

Import the StarRatingModule into your module

import { ShimmerModule } from '@sreyaj/ng-shimmer';
@NgModule({
  ...
  imports: [ShimmerModule],
  ...
})
export class AppModule {}

Now you can use the component inside your application

<shimmer></shimmer>

You can now customize it with the following attributes

Eg with few options:

<shimmer [width]="'100px'" [type]="'circle'"></shimmer>

Customizations

FeatureDescriptionAttributeTypeDefault
Type Of ShimmerYou can change the appearance of the shimmertype'line' or 'circle' or 'square''line
Width of the ShimmerShimmer width can be customized according to your needwidthstring'100%'
Height of the ShimmerShimmer height can be customized according to your needheightstring'12px'
Animation DurationShimmer animation duration can be customized according to your needdurationstring'1s'
RoundedShimmer corners can be rounded of for 'line' or 'square' typeroundedbooleanfalse

Feel free to open Issues and Pull Requests