UNPKG

@patternfly/react-core

Version:

This library provides a set of common React components for use with the PatternFly reference implementation.

127 lines 6.81 kB
import { __rest } from "tslib"; import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime"; import { cloneElement, createRef, useEffect, useState } from 'react'; import styles from '@patternfly/react-styles/css/components/Tooltip/tooltip.mjs'; import { css } from '@patternfly/react-styles'; import { TooltipContent } from './TooltipContent'; import { TooltipArrow } from './TooltipArrow'; import { KeyTypes } from '../../helpers/constants'; import tooltipMaxWidth from '@patternfly/react-tokens/dist/esm/c_tooltip_MaxWidth'; import { Popper } from '../../helpers/Popper/Popper'; export var TooltipPosition; (function (TooltipPosition) { TooltipPosition["auto"] = "auto"; TooltipPosition["top"] = "top"; TooltipPosition["bottom"] = "bottom"; TooltipPosition["left"] = "left"; TooltipPosition["right"] = "right"; TooltipPosition["topStart"] = "top-start"; TooltipPosition["topEnd"] = "top-end"; TooltipPosition["bottomStart"] = "bottom-start"; TooltipPosition["bottomEnd"] = "bottom-end"; TooltipPosition["leftStart"] = "left-start"; TooltipPosition["leftEnd"] = "left-end"; TooltipPosition["rightStart"] = "right-start"; TooltipPosition["rightEnd"] = "right-end"; })(TooltipPosition || (TooltipPosition = {})); // id for associating trigger with the content aria-describedby or aria-labelledby let pfTooltipIdCounter = 1; export const Tooltip = (_a) => { var { content: bodyContent, position = 'top', trigger = 'mouseenter focus', isVisible = false, isContentLeftAligned = false, enableFlip = true, className = '', entryDelay = 300, exitDelay = 300, appendTo = () => document.body, zIndex = 9999, minWidth, maxWidth = tooltipMaxWidth.value, distance = 15, aria = 'describedby', // For every initial starting position, there are 3 escape positions flipBehavior = ['top', 'right', 'bottom', 'left', 'top', 'right', 'bottom'], id = `pf-tooltip-${pfTooltipIdCounter++}`, children, animationDuration = 300, triggerRef, 'aria-live': ariaLive = triggerRef ? 'polite' : 'off', onTooltipHidden = () => { } } = _a, rest = __rest(_a, ["content", "position", "trigger", "isVisible", "isContentLeftAligned", "enableFlip", "className", "entryDelay", "exitDelay", "appendTo", "zIndex", "minWidth", "maxWidth", "distance", "aria", "flipBehavior", "id", "children", "animationDuration", "triggerRef", 'aria-live', "onTooltipHidden"]); // could make this a prop in the future (true | false | 'toggle') const hideOnClick = true; const triggerOnMouseenter = trigger.includes('mouseenter'); const triggerOnFocus = trigger.includes('focus'); const triggerOnClick = trigger.includes('click'); const triggerManually = trigger === 'manual'; const [visible, setVisible] = useState(false); const popperRef = createRef(); const onDocumentKeyDown = (event) => { if (!triggerManually) { if (event.key === KeyTypes.Escape && visible) { hide(); } } }; const onTriggerEnter = (event) => { if (event.key === KeyTypes.Enter) { if (!visible) { show(); } else { hide(); } } }; useEffect(() => { if (isVisible) { show(); } else { hide(); } }, [isVisible]); const show = () => { setVisible(true); }; const hide = () => { setVisible(false); }; const positionModifiers = { top: styles.modifiers.top, bottom: styles.modifiers.bottom, left: styles.modifiers.left, right: styles.modifiers.right, 'top-start': styles.modifiers.topLeft, 'top-end': styles.modifiers.topRight, 'bottom-start': styles.modifiers.bottomLeft, 'bottom-end': styles.modifiers.bottomRight, 'left-start': styles.modifiers.leftTop, 'left-end': styles.modifiers.leftBottom, 'right-start': styles.modifiers.rightTop, 'right-end': styles.modifiers.rightBottom }; const hasCustomMaxWidth = maxWidth !== tooltipMaxWidth.value; const content = (_jsxs("div", Object.assign({ "aria-live": ariaLive, className: css(styles.tooltip, className), role: "tooltip", id: id, style: { maxWidth: hasCustomMaxWidth ? maxWidth : null }, ref: popperRef }, rest, { children: [_jsx(TooltipArrow, {}), _jsx(TooltipContent, { isLeftAligned: isContentLeftAligned, children: bodyContent })] }))); const onDocumentClick = (event, triggerElement) => { // event.currentTarget = document // event.target could be triggerElement or something else if (hideOnClick === true) { // hide on inside the toggle as well as on outside clicks if (visible) { hide(); } else if (event.target === triggerElement) { show(); } } else if (hideOnClick === 'toggle' && event.target === triggerElement) { // prevent outside clicks from hiding but allow it to still be toggled on toggle click if (visible) { hide(); } else { show(); } } else if (hideOnClick === false && !visible && event.target === triggerElement) { show(); } }; const addAriaToTrigger = () => { if (aria === 'describedby' && children && children.props && !children.props['aria-describedby']) { return cloneElement(children, { 'aria-describedby': id }); } else if (aria === 'labelledby' && children.props && !children.props['aria-labelledby']) { return cloneElement(children, { 'aria-labelledby': id }); } return children; }; return (_jsx(Popper, { trigger: aria !== 'none' && visible ? addAriaToTrigger() : children, triggerRef: triggerRef, popper: content, popperRef: popperRef, minWidth: minWidth !== undefined ? minWidth : 'revert', appendTo: appendTo, isVisible: visible, positionModifiers: positionModifiers, distance: distance, placement: position, onMouseEnter: triggerOnMouseenter && show, onMouseLeave: triggerOnMouseenter && hide, onPopperMouseEnter: triggerOnMouseenter && show, onPopperMouseLeave: triggerOnMouseenter && hide, onFocus: triggerOnFocus && show, onBlur: triggerOnFocus && hide, onDocumentClick: triggerOnClick && onDocumentClick, onDocumentKeyDown: triggerManually ? null : onDocumentKeyDown, onTriggerEnter: triggerManually ? null : onTriggerEnter, enableFlip: enableFlip, zIndex: zIndex, flipBehavior: flipBehavior, animationDuration: animationDuration, entryDelay: entryDelay, exitDelay: exitDelay, onHidden: onTooltipHidden })); }; Tooltip.displayName = 'Tooltip'; //# sourceMappingURL=Tooltip.js.map