OptionalalertText announced by screen reader when alert severity variant is set to indicate severity level.
OptionalalertSeverity variants for an alert popover. This modifies the color of the header to match the severity.
OptionalanimationThe duration of the CSS fade transition animation.
OptionalappendThe element to append the popover to. Defaults to "inline".
Optionalaria-Accessible label for the popover, required when header is not present.
Body content of the popover. If you want to close the popover after an action within the body content, you can use the isVisible prop for manual control, or you can provide a function which will receive a callback as an argument to hide the popover, i.e. bodyContent={hide => <Button onClick={() => hide()}>Close}
OptionalchildrenThe trigger reference element to which the popover is relatively placed to. If you cannot wrap
the element with the Popover, you can use the triggerRef prop instead.
Usage:
OptionalclassAdditional classes added to the popover.
OptionalcloseAccessible label for the close button.
OptionaldistanceDistance of the popover to its target. Defaults to 25.
OptionalelementThe element to focus when the popover becomes visible. By default the first focusable element will receive focus.
OptionalenableIf true, tries to keep the popover in view by flipping it if necessary. If the position is set to 'auto', this prop is ignored.
OptionalflipThe desired position to flip the popover to if the initial position is not possible. By setting this prop to 'flip' it attempts to flip the popover to the opposite side if there is no space. You can also pass an array of positions that determines the flip order. It should contain the initial position followed by alternative positions if that position is unavailable. Example: Initial position is 'top'. Button with popover is in the top right corner. 'flipBehavior' is set to ['top', 'right', 'left']. Since there is no space to the top, it checks if right is available. There's also no space to the right, so it finally shows the popover on the left.
OptionalfooterFooter content of the popover. If you want to close the popover after an action within the footer content, you can use the isVisible prop for manual control, or you can provide a function which will receive a callback as an argument to hide the popover, i.e. footerContent={hide => <Button onClick={() => hide()}>Close}
OptionalhasRemoves fixed-width and allows width to be defined by contents.
OptionalhasAllows content to touch edges of popover container.
OptionalheaderSets the heading level to use for the popover header. Defaults to h6.
OptionalheaderSimple header content to be placed within a title. If you want to close the popover after an action within the header content, you can use the isVisible prop for manual control, or you can provide a function which will receive a callback as an argument to hide the popover, i.e. headerContent={hide => <Button onClick={() => hide()}>Close}
OptionalheaderIcon to be displayed in the popover header. *
OptionalhideHides the popover when a click occurs outside (only works if isVisible is not controlled by the user).
OptionalidId used as part of the various popover elements (popover-${id}-header/body/footer).
OptionalisTrue to show the popover programmatically. Used in conjunction with the shouldClose prop. By default, the popover child element handles click events automatically. If you want to control this programmatically, the popover will not auto-close if the close button is clicked, the escape key is used, or if a click occurs outside the popover. Instead, the consumer is responsible for closing the popover themselves by adding a callback listener for the shouldClose prop.
OptionalmaxMaximum width of the popover (default 18.75rem).
OptionalminMinimum width of the popover (default 6.25rem).
OptionalonLifecycle function invoked when the popover has fully transitioned out.
OptionalonLifecycle function invoked when the popover begins to transition out.
OptionalonLifecycle function invoked when the popover has been mounted to the DOM.
OptionalonLifecycle function invoked when the popover begins to transition in.
OptionalonLifecycle function invoked when the popover has fully transitioned in.
OptionalpositionPopover position. Note: With the enableFlip property set to true, it will change the position if there is not enough space for the starting position. The behavior of where it flips to can be controlled through the flipBehavior property.
OptionalshouldCallback function that is only invoked when isVisible is also controlled. Called when the popover close button is clicked, the enter key was used on it, or the escape key is used.
OptionalshouldCallback function that is only invoked when isVisible is also controlled. Called when the enter key is used on the focused trigger.
OptionalshowFlag indicating whether the close button should be shown.
OptionaltriggerSets an interaction to open popover, defaults to "click"
OptionaltriggerThe trigger reference element to which the popover is relatively placed to. If you can wrap the element with the popover, you can use the children prop instead, or both props together. When passed along with the trigger prop, the div element that wraps the trigger will be removed. Usage: <Popover triggerRef={() => document.getElementById('reference-element')} />
OptionalwithWhether to trap focus in the popover.
OptionalzThe z-index of the popover.
The main popover component. The following properties can also be passed into another component that has a property specifically for passing in popover properties.