Open In App

React Suite Tooltip <Whisper> Props

Last Updated : 22 Jun, 2022
Improve
Improve
Like Article
Like
Save
Share
Report

React Suite is a popular front-end library with a set of React components that are designed for the middle platform and back-end products. The tooltip component allows the user to display informative text when users hover over, focus on, or tap an element. 

Whisper Binds an event to an element and displays an overlay when triggered. <Whisper> Monitor triggers, wrap the outside of the listener object, and notify the Tooltip when the event is triggered

Whisper Props:

  • container: It is used to set the rendering container.
  • delay: It is used to denote the delay time.
  • delayHide: It is used to denote the hidden delay time.
  • delayShow: It is used to show delay time.
  • onBlur: It is a function that is triggered by losing focus.
  • onClick: It is a function that is triggered on a click event.
  • onEnter: It is a function that is triggered before the overlay transitions in.
  • onEntered: It is a function that is triggered after the overlay finishes transitioning in.
  • onEntering: It is a function that is triggered as the overlay begins to transition in.
  • onExit: It is a function that is triggered right before the overlay transitions out.
  • onExited: It is a function that is triggered after the overlay finishes transitioning out.
  • onExiting: It is a function that is triggered as the overlay begins to transition out.
  • onFocus: It is a function that is triggered to get focus.
  • onMouseOut: It is a function that is triggered on the mouse leave event.
  • placement: It is used for the placement of the component.
  • preventOverflow: It is used to prevent floating element overflow.
  • speaker: It is used for the displayed component.
  • trigger: It is used for the triggering events.

Creating React Application And Installing Module:

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

npx create-react-app foldername

Step 2: After creating your project folder i.e. foldername, move to it using the following command:

cd foldername

Step 3: After creating the ReactJS application, Install the required module using the following command:

npm install rsuite

Project Structure: It will look like the following.

 

Example 1: Now write down the following code in the App.js file. Here, App is our default component where we have written our code. In this example, we will learn about props like placement, trigger, speaker and appearance.

Javascript




import React from 'react'
import "rsuite/dist/rsuite.min.css";
import { Button, Tooltip, Whisper } from 'rsuite'
  
export default function App() {
    return (
        <div style={{
            display: 'block', width: 700, paddingLeft: 30
        }}>
            <h1 style={{ color: 'green' }}>GeeksforGeeks</h1>
            <h3>React Suite Whisper Props</h3>
            <Whisper
                trigger="click"
                placement="right"
                speaker={<Tooltip >Required Text</Tooltip>}
            >
                <Button appearance="subtle">Right</Button>
            </Whisper>
            <br />
            <hr />
            <Whisper
                trigger="click"
                placement="topStart"
                speaker={<Tooltip >Required Text</Tooltip>}
            >
                <Button appearance="subtle">Top Start</Button>
            </Whisper>
            <br /> <hr />
            <Whisper
                trigger="click"
                placement="bottomStart"
                speaker={<Tooltip >Required Text</Tooltip>}
            >
                <Button appearance="subtle">Bottom Start</Button>
            </Whisper>
            <br /> <hr />
        </div>
    );
}


Step to Run Application: Run the application using the following command from the root directory of the project:

npm start

Output: Now open your browser and go to http://localhost:3000/, you will see the following output:

 

Example 2: In this example, we will show, how can we use heading tags as speakers. Also, show the use of followCursor.

Javascript




import React from 'react'
import "rsuite/dist/rsuite.min.css";
import { Button, Tooltip, Whisper } from 'rsuite'
  
export default function App() {
    return (
        <div style={{
            display: 'block', width: 700, paddingLeft: 30
        }}>
            <h1 style={{ color: 'green' }}>GeeksforGeeks</h1>
            <h3>React Suite Whisper Props</h3>
  
            <Whisper
                trigger="click"
                placement="bottomStart"
                followCursor
                speaker={<Tooltip >Required Text</Tooltip>}
            >
                <Button appearance="subtle">Follow Cursor</Button>
            </Whisper>
            <br /> <hr />
            <Whisper
                trigger="click"
                speaker={<h3 style={{ color: 'red' }} >
                    GeeksforGeeks
                </h3>}
            >
                <Button appearance="subtle">Click me</Button>
            </Whisper>
            <br />
        </div>
    );
}


Output:

 

Reference: https://rsuitejs.com/components/tooltip/#code-lt-whisper-gt-code



Like Article
Suggest improvement
Previous
Next
Share your thoughts in the comments

Similar Reads