/* * Copyright 2021 Palantir Technologies, Inc. All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import classNames from "classnames"; import { createRef } from "react"; import { AbstractPureComponent, DISPLAYNAME_PREFIX, type IntentProps } from "../../common"; import * as Classes from "../../common/classes"; import { TOOLTIP_ARROW_SVG_SIZE } from "../popover/popoverArrow"; import type { PopoverInteractionKind } from "../popover/popoverProps"; import type { DefaultPopoverTargetHTMLProps, PopoverSharedProps } from "../popover/popoverSharedProps"; import { TooltipContext, type TooltipContextState, TooltipProvider } from "../popover/tooltipContext"; import { PopoverNext, type PopoverNextRef } from "../popover-next/popoverNext"; import { popoverPropsToNextProps } from "../popover-next/popoverNextMigrationUtils"; export interface TooltipProps extends Omit, "shouldReturnFocusOnClose">, IntentProps { /** * The content that will be displayed inside of the tooltip. */ content: React.JSX.Element | string; /** * Whether to use a compact appearance, which reduces the visual padding around * tooltip content. * * @default false */ compact?: boolean; /** * The amount of time in milliseconds the tooltip should remain open after * the user hovers off the trigger. The timer is canceled if the user mouses * over the target before it expires. * * @default 0 */ hoverCloseDelay?: number; /** * The amount of time in milliseconds the tooltip should wait before opening * after the user hovers over the trigger. The timer is canceled if the user * mouses away from the target before it expires. * * @default 100 */ hoverOpenDelay?: number; /** * The kind of hover interaction that triggers the display of the tooltip. * Tooltips do not support click interactions. * * @default PopoverInteractionKind.HOVER_TARGET_ONLY */ interactionKind?: typeof PopoverInteractionKind.HOVER | typeof PopoverInteractionKind.HOVER_TARGET_ONLY; /** * Indicates how long (in milliseconds) the tooltip's appear/disappear * transition takes. This is used by React `CSSTransition` to know when a * transition completes and must match the duration of the animation in CSS. * Only set this prop if you override Blueprint's default transitions with * new transitions of a different length. * * @default 100 */ transitionDuration?: number; } /** * Tooltip component. * * @see https://blueprintjs.com/docs/#core/components/tooltip */ export class Tooltip< T extends DefaultPopoverTargetHTMLProps = DefaultPopoverTargetHTMLProps, > extends AbstractPureComponent> { public static displayName = `${DISPLAYNAME_PREFIX}.Tooltip`; public static defaultProps: Partial = { compact: false, hoverCloseDelay: 0, hoverOpenDelay: 100, interactionKind: "hover-target", minimal: false, transitionDuration: 100, }; private popoverRef = createRef(); public render() { // if we have an ancestor TooltipContext, we should take its state into account in this render path, // it was likely created by a parent ContextMenu return ( {([state]) => {this.renderPopover}} ); } public reposition() { this.popoverRef.current?.reposition(); } // any descendant ContextMenus may update this ctxState private renderPopover = (ctxState: TooltipContextState) => { const { children, compact, disabled, intent, popoverClassName, ...restProps } = this.props; const popoverClasses = classNames(Classes.TOOLTIP, Classes.intentClass(intent), popoverClassName, { [Classes.COMPACT]: compact, }); const nextProps = popoverPropsToNextProps(restProps); return ( {children} ); }; }