Popover

When the mouse clicks/moves in, the pop-up pop-up box is used to display more content.

  • <Popover> Pop-up box.
  • <Whisper> Monitor triggers, wrap the outside of the listener object, and notify the Tooltip when the event is triggered.

Usage

import { Popover, Whisper } from 'rsuite';

Examples

Default

Placement

Triggering events

Whisper provides a trigger props, which is used to control the display of Popover in different business scenarios. Props values ​​include:

  • click: It will be triggered when the element is clicked, and closed when clicked again.
  • focus: It is generally triggered when the user clicks or taps on an element or selects it with the keyboard's tab key.
  • hover: Will be triggered when the cursor (mouse pointer) is hovering over the element.
  • active: It is triggered when the element is activated.
  • none: No trigger event, generally used when it needs to be triggered by a method.

Note: Safari ignoring tabindex

Container and prevent overflow

Positioned popover components in scrolling container

Used with Dropdown

Overlay

Props

<Popover>

Property Type (Default) Description
children * React.Node The content of the component.
classPrefix string ('popover') The prefix of the component CSS class.
title React.Node The title of the component.
visible boolean The component is visible by default.

<Whisper>

Property Type (Default) Description
container HTMLElement or (() => HTMLElement) Sets the rendering container
delay number Delay Time
delayHide number Hidden delay Time
delayShow number Show Delay Time
enterable boolean Whether mouse is allowed to enter the floating layer of popover,when the value of trigger is set tohover
full boolean The content full the container
onBlur () => void Lose Focus callback function
onClick () => void Click on the callback function
onClose () => void Callback fired when close component
onEnter () => void Callback fired before the overlay transitions in
onEntered () => void Callback fired after the overlay finishes transitioning in
onEntering () => void Callback fired as the overlay begins to transition in
onExit () => void Callback fired right before the overlay transitions out
onExited () => void Callback fired after the overlay finishes transitioning out
onExiting () => void Callback fired as the overlay begins to transition out
onFocus () => void Callback function to get focus
onMouseOut () => void Mouse leave callback function
onOpen () => void Callback fired when open component
placement enum: PlacementAll ('right') Dispaly placement
preventOverflow boolean Prevent floating element overflow
speaker * union: Tooltip, Popover Displayed component
trigger union: 'click', 'hover', 'focus', 'active', 'none' (['hover','focus']) Triggering events
triggerRef React.Ref Ref of trigger

Whisper methods

  • open

Display a Popover.

open: (delay?: number) => void
  • close

Hide a Popover.

close: (delay?: number) => void

Related components