Skip to main content
Version: 3.xx.xx
Source Code

useNotification

It can be used to open or close notification at any time. It returns the open and close method from notificationProvider under the hood.

Basic Usage

Here is a basic example of how to use useNotification hook.

const { open, close } = useNotification();

// open notification
open?.({
type: "success",
message: "Success",
description: "This is a success message",
});

// close notification
close?.("notification-key");

Properties

open

You can call this method to open a new notification box.

const { open } = useNotification();

open?.({
type: "success",
message: "Success",
description: "This is a success message",
});

Refer to the Open Notification Params interface for more information →

close

You can close a notification with a key.

const { close } = useNotification();

close?.("notification-key");

Refer to the Close Notification Params interface for more information →

INFORMATION

You must pass a key to the open method. This key is used to close the notification.

FAQ

How to use a undoable notification?

It should be type=progress to show undoable notifications. A function can then be triggered.

const { open } = useNotification();

open?.({
type: "progress",
message: "Progress",
undoableTimeout: 5,
cancelMutation: () => {
// when undo button is clicked run this callback
},
});

API Reference

Return Values

PropertyDescriptionType
openOpen Notification ParamsOpen Notification Params
closeClose Notification ParamsClose Notification Params