/// import { Boundary as PopperBoundary, Modifiers as PopperModifiers, Placement } from "popper.js"; import { Props } from "../../common/props"; import { OverlayableProps } from "../overlay/overlay"; export { PopperBoundary, PopperModifiers }; /** `Position` with `"auto"` values, used by `Popover` and `Tooltip`. */ export declare const PopoverPosition: { AUTO: "auto"; AUTO_END: "auto-end"; AUTO_START: "auto-start"; BOTTOM: "bottom"; BOTTOM_LEFT: "bottom-left"; BOTTOM_RIGHT: "bottom-right"; LEFT: "left"; LEFT_BOTTOM: "left-bottom"; LEFT_TOP: "left-top"; RIGHT: "right"; RIGHT_BOTTOM: "right-bottom"; RIGHT_TOP: "right-top"; TOP: "top"; TOP_LEFT: "top-left"; TOP_RIGHT: "top-right"; }; export declare type PopoverPosition = typeof PopoverPosition[keyof typeof PopoverPosition]; /** Props shared between `Popover` and `Tooltip`. */ export interface IPopoverSharedProps extends OverlayableProps, Props { /** * Determines the boundary element used by Popper for its `flip` and * `preventOverflow` modifiers. Three shorthand keywords are supported; * Popper will find the correct DOM element itself. * * @default "scrollParent" */ boundary?: PopperBoundary; /** * When enabled, clicks inside a `Classes.POPOVER_DISMISS` element * will only close the current popover and not outer popovers. * When disabled, the current popover and any ancestor popovers will be closed. * * @see http://blueprintjs.com/docs/#core/components/popover.closing-on-click * @default false */ captureDismiss?: boolean; /** * Initial opened state when uncontrolled. * * @default false */ defaultIsOpen?: boolean; /** * Prevents the popover from appearing when `true`. * * @default false */ disabled?: boolean; /** * The amount of time in milliseconds the popover 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 300 */ hoverCloseDelay?: number; /** * The amount of time in milliseconds the popover 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 150 */ hoverOpenDelay?: number; /** * Whether a popover that uses a `Portal` should automatically inherit the * dark theme from its parent. * * @default true */ inheritDarkTheme?: boolean; /** * Whether the popover is visible. Passing this prop puts the popover in * controlled mode, where the only way to change visibility is by updating * this property. If `disabled={true}`, this prop will be ignored, and the * popover will remain closed. * * @default undefined */ isOpen?: boolean; /** * Whether to apply minimal styling to this popover or tooltip. Minimal popovers * do not have an arrow pointing to their target and use a subtler animation. * * @default false */ minimal?: boolean; /** * Popper modifier options, passed directly to internal Popper instance. See * https://popper.js.org/docs/modifiers/ for complete * details. */ modifiers?: PopperModifiers; /** * Callback invoked in controlled mode when the popover open state *would* * change due to user interaction. */ onInteraction?: (nextOpenState: boolean, e?: React.SyntheticEvent) => void; /** * Whether the popover should open when its target is focused. If `true`, * target will render with `tabindex="0"` to make it focusable via keyboard * navigation. * * @default true */ openOnTargetFocus?: boolean; /** * The placement (relative to the target) at which the popover should appear. * Mutually exclusive with `position` prop. * * The default value of `"auto"` will choose the best placement when opened * and will allow the popover to reposition itself to remain onscreen as the * user scrolls around. * * @see https://popper.js.org/docs/v1/#Popper.placements * @default "auto" */ placement?: Placement; /** * A space-delimited string of class names applied to the popover element. */ popoverClassName?: string; /** * The position (relative to the target) at which the popover should appear. * Mutually exclusive with `placement` prop. * * The default value of `"auto"` will choose the best position when opened * and will allow the popover to reposition itself to remain onscreen as the * user scrolls around. * * @default "auto" */ position?: PopoverPosition; /** * Space-delimited string of class names applied to the target element. */ targetClassName?: string; /** * HTML props to spread to target element. Use `targetTagName` to change * the type of element rendered. Note that `ref` is not supported. */ targetProps?: React.HTMLAttributes; /** * HTML tag name for the target element. This must be an HTML element to * ensure that it supports the necessary DOM event handlers. * * By default, a `` tag is used so popovers appear as inline-block * elements and can be nested in text. Use `
` tag for a block element. * * @default "span" */ targetTagName?: keyof JSX.IntrinsicElements; /** * Whether the popover should be rendered inside a `Portal` attached to * `portalContainer` prop. * * Rendering content inside a `Portal` allows the popover content to escape * the physical bounds of its parent while still being positioned correctly * relative to its target. Using a `Portal` is necessary if any ancestor of * the target hides overflow or uses very complex positioning. * * Not using a `Portal` can result in smoother performance when scrolling * and allows the popover content to inherit CSS styles from surrounding * elements, but it remains subject to the overflow bounds of its ancestors. * * @default true */ usePortal?: boolean; /** * HTML tag name for the wrapper element, which also receives the * `className` prop. * * @default "span" */ wrapperTagName?: keyof JSX.IntrinsicElements; }