on-deck-pack
v1.1.1
Published
This package can be used to send various type of notifications
Readme
On Deck Pack
On Deck Pack is a modular notification component library for React applications. It provides a component to help you easily integrate notification features into your project.
Features
- Modular notification components
- Customizable icons and styles
- Easy-to-use hooks for notification logic
- Utility functions for notification management
Getting Started
Refer to the sections below for installation, usage, and API details.
Installation
To install On Deck Pack, run the following command:
npm install on-deck-packUsage
To use On Deck Pack in your React application, import the Notification component:
import { Notification } from "on-deck-pack";Customization Example
You can customize the Notification component by passing props such as apiKey and recipientEmailId for recipientEmailId it should have the logged in user's email Id:
<Notification
apiKey="YOUR_ORG_API_KEY"
recipientEmailId="EMAIL_ID_FOR_LOGGED_IN_USER"
/>Replace the values with your own API key and recipient email ID as needed.
API
Components
Notification
Hooks
useNotification
License
On Deck Pack is open-source software licensed under the MIT License. See the LICENSE file for details.
