@base-ui-components/react
Version:
Base UI is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.
190 lines (189 loc) • 7.71 kB
JavaScript
"use strict";
'use client';
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.TooltipPositioner = void 0;
var React = _interopRequireWildcard(require("react"));
var _propTypes = _interopRequireDefault(require("prop-types"));
var _useComponentRenderer = require("../../utils/useComponentRenderer");
var _proptypes = require("../../utils/proptypes");
var _useForkRef = require("../../utils/useForkRef");
var _TooltipRootContext = require("../root/TooltipRootContext");
var _TooltipPositionerContext = require("./TooltipPositionerContext");
var _useTooltipPositioner = require("./useTooltipPositioner");
var _popupStateMapping = require("../../utils/popupStateMapping");
var _jsxRuntime = require("react/jsx-runtime");
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
/**
* Positions the tooltip against the trigger.
* Renders a `<div>` element.
*
* Documentation: [Base UI Tooltip](https://base-ui.com/react/components/tooltip)
*/const TooltipPositioner = exports.TooltipPositioner = /*#__PURE__*/React.forwardRef(function TooltipPositioner(props, forwardedRef) {
const {
render,
className,
anchor,
keepMounted = false,
positionMethod = 'absolute',
side = 'top',
align = 'center',
sideOffset = 0,
alignOffset = 0,
collisionBoundary = 'clipping-ancestors',
collisionPadding = 5,
arrowPadding = 5,
sticky = false,
...otherProps
} = props;
const {
open,
setPositionerElement,
mounted,
floatingRootContext,
trackCursorAxis
} = (0, _TooltipRootContext.useTooltipRootContext)();
const positioner = (0, _useTooltipPositioner.useTooltipPositioner)({
anchor,
floatingRootContext,
positionMethod,
open,
mounted,
keepMounted,
side,
sideOffset,
align,
alignOffset,
collisionBoundary,
collisionPadding,
sticky,
trackCursorAxis,
arrowPadding
});
const mergedRef = (0, _useForkRef.useForkRef)(forwardedRef, setPositionerElement);
const state = React.useMemo(() => ({
open,
side: positioner.side,
align: positioner.align,
anchorHidden: positioner.anchorHidden
}), [open, positioner.side, positioner.align, positioner.anchorHidden]);
const contextValue = React.useMemo(() => ({
...state,
arrowRef: positioner.arrowRef,
arrowStyles: positioner.arrowStyles,
arrowUncentered: positioner.arrowUncentered
}), [state, positioner.arrowRef, positioner.arrowStyles, positioner.arrowUncentered]);
const {
renderElement
} = (0, _useComponentRenderer.useComponentRenderer)({
propGetter: positioner.getPositionerProps,
render: render ?? 'div',
className,
state,
ref: mergedRef,
extraProps: otherProps,
customStyleHookMapping: _popupStateMapping.popupStateMapping
});
const shouldRender = keepMounted || mounted;
if (!shouldRender) {
return null;
}
return /*#__PURE__*/(0, _jsxRuntime.jsx)(_TooltipPositionerContext.TooltipPositionerContext.Provider, {
value: contextValue,
children: renderElement()
});
});
process.env.NODE_ENV !== "production" ? TooltipPositioner.propTypes /* remove-proptypes */ = {
// ┌────────────────────────────── Warning ──────────────────────────────┐
// │ These PropTypes are generated from the TypeScript type definitions. │
// │ To update them, edit the TypeScript types and run `pnpm proptypes`. │
// └─────────────────────────────────────────────────────────────────────┘
/**
* How to align the popup relative to the specified side.
* @default 'center'
*/
align: _propTypes.default.oneOf(['center', 'end', 'start']),
/**
* Additional offset along the alignment axis of the element.
* @default 0
*/
alignOffset: _propTypes.default.number,
/**
* An element to position the popup against.
* By default, the popup will be positioned against the trigger.
*/
anchor: _propTypes.default /* @typescript-to-proptypes-ignore */.oneOfType([_proptypes.HTMLElementType, _propTypes.default.object, _propTypes.default.func]),
/**
* Minimum distance to maintain between the arrow and the edges of the popup.
*
* Use it to prevent the arrow element from hanging out of the rounded corners of a popup.
* @default 5
*/
arrowPadding: _propTypes.default.number,
/**
* @ignore
*/
children: _propTypes.default.node,
/**
* CSS class applied to the element, or a function that
* returns a class based on the component’s state.
*/
className: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.string]),
/**
* An element or a rectangle that delimits the area that the popup is confined to.
* @default 'clipping-ancestors'
*/
collisionBoundary: _propTypes.default /* @typescript-to-proptypes-ignore */.oneOfType([_proptypes.HTMLElementType, _propTypes.default.arrayOf(_proptypes.HTMLElementType), _propTypes.default.string, _propTypes.default.shape({
height: _propTypes.default.number,
width: _propTypes.default.number,
x: _propTypes.default.number,
y: _propTypes.default.number
})]),
/**
* Additional space to maintain from the edge of the collision boundary.
* @default 5
*/
collisionPadding: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.shape({
bottom: _propTypes.default.number,
left: _propTypes.default.number,
right: _propTypes.default.number,
top: _propTypes.default.number
})]),
/**
* Whether to keep the HTML element in the DOM while the tooltip is hidden.
* @default false
*/
keepMounted: _propTypes.default.bool,
/**
* Determines which CSS `position` property to use.
* @default 'absolute'
*/
positionMethod: _propTypes.default.oneOf(['absolute', 'fixed']),
/**
* Allows you to replace the component’s HTML element
* with a different tag, or compose it with another component.
*
* Accepts a `ReactElement` or a function that returns the element to render.
*/
render: _propTypes.default.oneOfType([_propTypes.default.element, _propTypes.default.func]),
/**
* Which side of the anchor element to align the popup against.
* May automatically change to avoid collisions.
* @default 'top'
*/
side: _propTypes.default.oneOf(['bottom', 'inline-end', 'inline-start', 'left', 'right', 'top']),
/**
* Distance between the anchor and the popup.
* @default 0
*/
sideOffset: _propTypes.default.number,
/**
* Whether to maintain the popup in the viewport after
* the anchor element was scrolled out of view.
* @default false
*/
sticky: _propTypes.default.bool
} : void 0;