0.3.3 • Published 5 days ago

react-handle-alert v0.3.3

Weekly downloads
-
License
MIT
Repository
github
Last release
5 days ago

react-handle-alert

react-handle-alert is designed to be used as pure functions without the need for integrating any components into your React component tree. This makes it incredibly easy to trigger alerts and confirmations directly from your functional logic or event handlers.

Example

Features

  • Custom Alerts: Displays custom alerts that provide information to users.
  • Custom Confirms: Enables the implementation of confirmation dialogs that require user decisions.
  • Fully Customizable: Allows for the customization of modal backgrounds, styles, button texts, and button styles.

Getting Started

npm install react-handle-alert

yarn add react-handle-alert

Usage

Below is a basic example of how to use the react-handle-alert library:

import { handleAlert, handleConfirm } from "react-handle-alert";

# alert
handleAlert("alert message")

# confirm
handleConfirm("confirm message").then(action => {
  console.log(action ? "confirm", "cancel");
})

# OR
const action = await handleConfirm("confirm message");
console.log(action ? "confirm", "cancel");

Customization

Customization is possible using custom hooks or files.

import { handleAlert, handleConfirm } from "react-handle-alert";

export const useModal = () => {
  const customAlert = (text: string) =>
    handleAlert(text, {
      backgroundStyle: { backgroundColor: "rgba(0, 0, 0, 0.5)" },
      style: { backgroundColor: "white", color: "black" },
      button: {
        text: "close",
        style: { backgroundColor: "blue" },
      },
    });

  const customConfirm = async (text: string) =>
    await handleConfirm(text, {
      backgroundStyle: { backgroundColor: "rgba(0, 0, 0, 0.5)" },
      style: { backgroundColor: "white", color: "black" },
      cancelButton: {
        text: "cancel",
        style: { backgroundColor: "red", border: "none", color: "white" },
      },
      confirmButton: {
        text: "confirm",
        style: { backgroundColor: "green" },
      },
    });

  return { customAlert, customConfirm };
};

Options

OptionDescriptionTypeDefault Value
backgroundStyleStyle for the modal backgroundCSSProperties{ backgroundColor: "rgba(0, 0, 0, 0.3)" }
styleStyle for the modal bodyCSSProperties{ backgroundColor: "white", color: "black" }
buttonText and style for the default buttonObject{ text: "Close", style: { backgroundColor: "blue" } }
cancelButtonText and style for the cancel buttonObject{ text: "Cancel", style: { backgroundColor: "red", color: "white", border: "none" } }
confirmButtonText and style for the confirm buttonObject{ text: "Confirm", style: { backgroundColor: "green" } }
closeOnBackgroundClickDetermines if clicking the background closes the modalbooleantrue

License

MIT © dochi.

0.3.3

5 days ago

0.3.2

15 days ago

0.3.0

19 days ago

0.3.1

18 days ago

0.2.0

20 days ago

0.1.1

20 days ago

0.1.0

20 days ago