1.0.3 • Published 4 months ago

next-alert v1.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

💌 next-alert

The next-alert library allows for easy integration and management of notifications / alerts in your Next.js 13/14 application.

Demo

demo

Go to Demo

Installation

To install next-alert, use one of the following commands in your terminal:

npm install framer-motion next-alert
# or
yarn add framer-motion next-alert

Why do you need to install Framer-motion? Because the next alert uses Framer-motion for animation and I don't want to add this dependency in the next alert because you may be using a different version of Framer-motion for animation in your project.

Usage

In main component you must use provider:

import { AlertProvider } from "next-alert";

export default function Home() {
	return (
        <AlertProvider>
            <Components/>
        </AlertProvider>
    )
}

In component use like this:

"use client";
import { useAlert } from "next-alert";
import { Alerts } from "next-alert";

const Component = () => {
	const { addAlert } = useAlert();

    const handleClick = () => {
        addAlert("Title","Description","Type", () => { function execute after alert gone (optional) });
    }
    return (
        <div>
            // this component is container for showing notifications 
            <Alerts
				position="top-right"
				direction="right"
				timer={3000}
				className="rounded-md relative z-50 !w-80"
			>
                <SVG | or else files/>
            </Alerts>
        </div>
    )
}

Docs

ParamOptionsDefault
---------------Alert component params----------------------
positiontop-left, top-right, bottom-left, bottom-right, center-top, center-bottomtop-right
directionleft, right, top, bottomright
timernumber3000
classNametailwind classempty, you can change defaut styles by add !
---------------Alert hook params----------------------
titlestringempty
descriptionstringempty
typesuccess, error, warning, infoempty
---------------Alert Import Types----------------------
AlertPropsinterface AlertProps
AlertType"success" | "error" | "warning" | "info"
AlertDirection"left" | "right" | "top" | "bottom"
AlertPosition"top-left" | "top-right" | "bottom-left" | "bottom-right" | "center-top" | "center-bottom"

Dependencies

    "framer-motion": ">=10",
    "react": ">=16",
    "react-dom": ">=16",
    "tailwindcss": ">=3.0.0"

🥰 Author

TheLoloS

License

Mit

Note: next-alert is actively being developed, so we recommend regularly checking for the latest versions and updating your application.

1.0.2

4 months ago

1.0.1

4 months ago

1.0.0

4 months ago

1.0.3

4 months ago

0.6.3

4 months ago

0.6.2

4 months ago

0.6.5

4 months ago

0.6.4

4 months ago

0.5.11

4 months ago

0.5.4

4 months ago

0.5.6

4 months ago

0.5.5

4 months ago

0.5.0

4 months ago

0.5.2

4 months ago

0.5.1

4 months ago

0.5.8

4 months ago

0.5.7

4 months ago

0.5.9

4 months ago

0.6.1

4 months ago

0.6.0

4 months ago

0.4.9

4 months ago

0.4.8

4 months ago

0.4.5

4 months ago

0.4.4

4 months ago

0.4.7

4 months ago

0.4.6

4 months ago

0.4.3

4 months ago

0.4.2

4 months ago

0.3.9

5 months ago

0.3.0

5 months ago

0.3.6

5 months ago

0.2.7

5 months ago

0.3.5

5 months ago

0.2.6

5 months ago

0.3.8

5 months ago

0.2.9

5 months ago

0.3.7

5 months ago

0.2.8

5 months ago

0.4.1

5 months ago

0.3.2

5 months ago

0.4.0

5 months ago

0.3.1

5 months ago

0.2.2

5 months ago

0.3.4

5 months ago

0.2.5

5 months ago

0.3.3

5 months ago

0.2.4

5 months ago

0.2.1

5 months ago

0.2.0

5 months ago

0.1.6

5 months ago

0.1.5

5 months ago

0.1.4

5 months ago

0.1.3

5 months ago

0.1.2

5 months ago

0.1.1

5 months ago

0.1.0

5 months ago