0.0.4 • Published 9 months ago

react-notification-ui v0.0.4

Weekly downloads
-
License
-
Repository
github
Last release
9 months ago

The react-notification-ui library helps you in displaying notification in beautiful and easy way.

Table of contents

  1. Installation
  2. Demo
  3. Basic Usage

Installation

  • Using NPM npm i react-notification-ui

  • Using Yarn yarn add react-notification-ui

Demo

https://stackblitz.com/edit/react-notification-ui

Code example

https://github.com/Roxiler/react-notification-ui/blob/main/src/App.tsx

Checkout below gif.

npm.io

Basic Usage of Notify

  • Demo 1 : For Predefined card data need data in this format :

    import { Notify } from 'react-notification-ui';
    
    const data = [
      {
        image: 'https://reqres.in/img/faces/1-image.jpg',
        title: 'Aryan Ty',
        description:
          'Lorem, ipsum dolor sit amet consectetur adipisicing elit. Vel, cumque!',
        time: '2 days',
      },
      {
        image: 'https://reqres.in/img/faces/2-image.jpg',
        title: 'Aryan Tirkey',
        description:
          'Lorem, ipsum dolor sit amet consectetur adipisicing elit. Vel, cumque!',
        time: '1 days',
      },
      {
        image: 'https://reqres.in/img/faces/3-image.jpg',
        title: 'Roxiler System',
        description:
          'Lorem, ipsum dolor sit amet consectetur adipisicing elit. Vel, cumque!',
        time: '1 days',
      },
      {
        image: 'https://reqres.in/img/faces/4-image.jpg',
        title: 'Jhon Doe',
        description:
          'Lorem, ipsum dolor sit amet consectetur adipisicing elit. Vel, cumque!',
        time: '10 sec',
      },
    ];
    
    export default function App() {
      return (
        <div>
          <Notify data={data} />
        </div>
      );
    }
  • For theme, number of card shown and hiding count indicator :

    <Notify data={data} theme="dark" maxCardShown={3} hideCount />
  • For passing CustomIcon, CustomButton, CustomCard and custom data :

    <Notify data={data} customButton={<CustomButton/>} customCard={<CustomCard/>} customIcon={<CustomIcon/>} />
    
    const CustomCard = (e) => {
        return <div onClick={e.onClick}>{e.data.title}</div>
    }
    
    const CustomIcon = () => {
        return <div><img src /></div>
    }
    
    const CustomButton = (e) => {
        return <button>{e.label}</button>
    }
  • changing position and transition , while position change cardPosition and transformOrigin are required :

    <Notify data={data} cardPosition="top"  transformOrigin={x:"top", y:"top"}/>

props

Accepted propstypeDescription
cardPositionstringsets card position like "left","right","top","bottom"
transformOriginobjectwith combination of cardPosition this is used to set origin position x and y
hideCountbooleanset card count visible or hidden, by default its false
notificationCountVariantstringset notification count variant
customIconReactNodepass custom icon component
customCardReactNodepass custom card component
cardPropsobjectsets card style , variant and onClick to card
customButtonReactNodepass custom button component for show more
buttonPropsobjectsets show more button style and label
dropBoxStylecss propertiespass css to control the position , and style of component
dropBoxShadowstringchoose from various shadow style
dataobjectpass props from example 1.1 when using predefined card
maxCardShownnumberset number of card to be shown
showShowMoreBtnbooleanset if you want show more button to be visible or hidden
dropAnimationstringchoose from various drop animation
dropAnimationstringchoose from various drop animation
themestringchoose from dark or light theme