README.md

ion-celebration

📝 Table of Contents

• Prerequisites
• Install
• Setup
• Usage
• Author
• Contributing
• Show your support
• License

✅ Prerequisites

The current version of the library is compatible with Ionic 6+.

⬇️ Install

Using npm

npm install ion-celebration --save

Using yarn

yarn add ion-celebration

🛠 Setup

Once installed you need to import our module in the parent module for the component you will be using it in:

import { IonCelebrationModule } from 'ion-celebration';

@NgModule({
  ...
  imports: [IonCelebrationModule, ...],
  ...
})
export class YourModule {
}

Usage

Include the component on page template, like the example below:

  <ion-celebration
   [name]="'balloon'"
   [time]="10000">
   </ion-celebration>

API

Properties

• name: string any valid ion-icon name.
• time: number time in miliseconds to show animation. default 5000.

Author

👤 Najam Us Saqib

• Github: @saqib92

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Saqb92.
This project is MIT licensed.