React Suite Notification toaster.clear Method

React Suite is a library of React components, sensible UI design, and a friendly development experience. It is supported in all major browsers. It provides pre-built components of React which can be used easily in any web application.

In this article, we’ll learn about React Suite Notification toaster.clear() method. This method is used to clear all messages of notifications. 

Notification Props:

• children: It gives the description of the message box.
• closable: It is used to add a remove button.
• duration: It is used to delay automatic closing notification, only effective when used in combination with a toaster.
• header: It is used to denote the title of the message box.
• onClose: It is a callback function that is called on the close of the Notification box.
• placement: It is used for the placement of the message box.
• type: It is used to denote the type of the message box.

Toaster Methods:

• toaster.push(): This method is used to push a message.
• toaster.remove(): This method is used to remove a message by key.
• toaster.clear(): This method is used to clear all messages.

Syntax:

<Notification type={'info'} header={'Info'} closable>
    ....
</Notification>

<Button onClick={() => toaster.clear() }>
...
</Button>

Creating React Application And Installing Module:

Step 1: Create a React application using the given command:

npm create-react-app projectname

Step 2: After creating your project, move to it using the given command:

cd projectname

Step 3: Now Install the rsuite node package using the given command:

npm install rsuite

Project Structure: Now your project structure should look like the following:

Example 1: Below example demonstrates the clear() method of the toaster component with a closable button.

Javascript

import { Button, Notification, useToaster } from "rsuite";
import "rsuite/dist/rsuite.min.css";

export default function App() {

    const toaster = useToaster();
    const message = (
        <Notification type={'success'}
            header={'Done'} closable>
            <p>You have registered.</p>
        </Notification>
    );

    return (
        <center>
            <div>
                <h2>GeeksforGeeks</h2>
                <h4 style={{ color: "green" }}>
                    React Suite Notification toaster.clear Method
                </h4>
                <div style={{ marginTop: 20, width: 400 }}>
                    <Button onClick={() => toaster.push(
                        message, { placement: 'bottomCenter' }
                    )}
                        style={{ marginRight: 5 }}>
                        Push
                    </Button>
                    <Button onClick={() => toaster.clear()}>
                        Clear
                    </Button>
                </div>
            </div>
        </center>
    );
}

Output:

Example 2: Below example demonstrates the clear method without a closable button component.

Javascript

import { Button, Notification, useToaster } from "rsuite";
import "rsuite/dist/rsuite.min.css";

export default function App() {

    const toaster = useToaster();
    const message = (
        <Notification type={'success'} header={'Done'}>
            <p>Clear this message with clear button.</p>
        </Notification>
    );

    return (
        <center>
            <div>
                <h2>GeeksforGeeks</h2>
                <h4 style={{ color: "green" }}>
                    React Suite Notification toaster.clear Method
                </h4>
                <div style={{ marginTop: 20, width: 400 }}>
                    <Button onClick={() => toaster.push(
                        message, { placement: 'bottomCenter' }
                    )} style={{ marginRight: 5 }}>
                        Push
                    </Button>
                    <Button onClick={() => toaster.clear()}>
                        Clear
                    </Button>
                </div>
            </div>
        </center>
    );
}

Output:

Reference: https://rsuitejs.com/components/notification/#toaster-clear