React friendly utility hook to trigger browser notifications.
Installation
pnpm
pnpm add @astre9/use-browser-notifications
yarn
yarn add @astre9/use-browser-notifications
npm
npm i @astre9/use-browser-notifications
Usage
Make sure your notification settings are ON! But if they aren't, expect Dwight to show up at your desk with a disappointed look.
Windows Users: Navigate to the dark realms of Settings > System > Notifications. Don't get lost!
macOS Fans: Seek out the elusive System Preferences > Notifications. You might find a hidden Dundie!
After setting up, here's a sneak peek of how to make the magic happen:
``js
import useNotification from "use-browser-notifications";
const App = () => {
const trigerNotification = useNotification("Dundie Award Nominations", {
body: "Nominate your colleagues for various Dundie Awards categories. Let's celebrate our exceptional team members!",
});
return (
);
};
``
Arguments
| Argument | Type | Description | Required |
| -------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
| title | string | This is a string that represents the title or heading of the notification. | yes |
| options | NotificationOptions | Notification options are configuration settings that customize the appearance and behavior of a notification, such as its body, icon, and sound. | no |
P.S.: This library only works if you turn on the notification settings. We don't want to be like Toby, always ignored!