1.0.0 • Published 1 year ago

react-quick-toastify v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

React Quick Toastify

React Quick Toastify is a simple and customizable toast notification component for React applications.

Installation

To install the package, run the following command:

npm install react-quick-toastify

Usage

Import the QuickToastify component and use it in your application. The component takes the following props:

  • isShow (boolean): Determines if the toast notification is shown.
  • setIsShow (function): A function to update the isShow state.
  • message (string): The message to display in the toast notification.
  • notificationType (string): The type of notification, either 'success' or 'error'.

Example

import React, { useState } from 'react';
import QuickToastify from 'react-quick-toastify';

const App = () => {
  const [isShow, setIsShow] = useState(false);

  const showToast = () => {
    setIsShow(true);
  };

  return (
    <div>
      <button onClick={showToast}>Show Toast</button>
      <QuickToastify 
        isShow={isShow} 
        setIsShow={setIsShow} 
        message="This is a success message!" 
        notificationType="success" 
      />
    </div>
  );
};

export default App;

Development

If you want to contribute or run the project locally, follow these steps:

  • Clone the repository First, clone the repository.
git clone https://github.com/CODEREXLTD/react-quick-toastify
  • Install dependencies Navigate to the project directory and install the dependencies:
cd react-quick-toastify
npm install
  • Run Storybook To run the Storybook for the component development and testing, use the following command:
npm run storybook

This will start the Storybook server and you can view your components in isolation at http://localhost:6006.

File Structure

  • src/components/toastify: Contains the QuickToastify component.
  • src/components/index.css: Contains the CSS for the QuickToastify component.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Issues

If you encounter any issues, please report them in the GitHub Issues section of the repository.

Acknowledgements

Thanks to the open-source community for their contributions and inspiration.