@soroush.tech/design-system 2.1.0-alpha.0 → 2.1.0-alpha.2

package/dist/Tooltip-rkGm1HnP.cjs

@@ -0,0 +1,417 @@
+const require_src = require("./src-yC1f5WR2.cjs");
+const require_theme = require("./theme-XJvMdOnY.cjs");
+const require_themeDefault = require("./themeDefault-DbPHBbNO.cjs");
+const require_getSurfaceRadius = require("./getSurfaceRadius-DwOn3ALC.cjs");
+const require_useControlled = require("./useControlled-CzCxM4J3.cjs");
+const require_Portal = require("./Portal.cjs");
+const require_useAnchoredPlacement = require("./useAnchoredPlacement-BSfjNMut.cjs");
+const require_useMergedRefs = require("./useMergedRefs-BtctsnmX.cjs");
+const require_getTooltipOrigins = require("./getTooltipOrigins-8b5zQafY.cjs");
+let react = require("react");
+let react_jsx_runtime = require("react/jsx-runtime");
+let _soroush_tech_styled_system_should_forward_prop = require("@soroush.tech/styled-system/should-forward-prop");
+// src/Tooltip/TooltipGroupContext.ts
+const TooltipGroupContext = (0, react.createContext)(null);
+/** The state of a group whose window is `skipDelayDuration` milliseconds long. */
+const createTooltipGroupState = (skipDelayDuration) => {
+	let active = null;
+	let closedAt = Number.NEGATIVE_INFINITY;
+	return {
+		shouldSkipDelay: () => active !== null || Date.now() - closedAt < skipDelayDuration,
+		open: (close) => {
+			active = close;
+		},
+		closeActive: (event) => active?.(event),
+		release: (close) => {
+			if (active !== close) return;
+			active = null;
+			closedAt = Date.now();
+		}
+	};
+};
+const themeGroups = /* @__PURE__ */ new WeakMap();
+const getThemeTooltipGroup = (theme, skipDelayDuration) => {
+	const byDuration = themeGroups.get(theme) ?? /* @__PURE__ */ new Map();
+	themeGroups.set(theme, byDuration);
+	const group = byDuration.get(skipDelayDuration) ?? createTooltipGroupState(skipDelayDuration);
+	byDuration.set(skipDelayDuration, group);
+	return group;
+};
+// src/Tooltip/hooks/useTooltip.ts
+const isKeyboardFocus = (event) => {
+	try {
+		return event.target.matches(":focus-visible");
+	} catch {
+		return true;
+	}
+};
+/**
+* The state of a tooltip: whether it is open (its own, or its owner's), the timers that open and
+* close it, and the handlers its child and the tooltip itself take. Opening and closing are
+* delayed; moving from the child onto the tooltip does not close it, so its text can be read and
+* selected (WCAG 1.4.13); Escape closes it at once.
+*/
+function useTooltip({ isOpen: isOpenProp, defaultOpen, isAtPoint = false, onOpen, onClose, enterDelay, leaveDelay, enterTouchDelay, leaveTouchDelay, shouldOpenOnHover, shouldOpenOnFocus, shouldOpenOnTouch, skipDelayDuration = 0 }) {
+	const [isOpen, setIsOpen] = require_useControlled.useControlled({
+		controlled: isOpenProp,
+		default: defaultOpen
+	});
+	const timer = (0, react.useRef)(void 0);
+	const theme = require_theme.useTheme();
+	const group = (0, react.useContext)(TooltipGroupContext) ?? (skipDelayDuration > 0 ? getThemeTooltipGroup(theme, skipDelayDuration) : null);
+	const latest = (0, react.useRef)({
+		isOpen,
+		isOpenProp,
+		isAtPoint,
+		onOpen,
+		onClose,
+		group
+	});
+	(0, react.useEffect)(() => {
+		latest.current = {
+			isOpen,
+			isOpenProp,
+			isAtPoint,
+			onOpen,
+			onClose,
+			group
+		};
+	});
+	const clear = (0, react.useCallback)(() => window.clearTimeout(timer.current), []);
+	const closeNow = (0, react.useCallback)((event) => {
+		clear();
+		const current = latest.current;
+		setIsOpen(false);
+		current.onClose?.(event);
+	}, [clear, setIsOpen]);
+	const isInGroup = group !== null && isOpenProp === void 0;
+	(0, react.useEffect)(() => {
+		if (!isInGroup || !isOpen) return void 0;
+		group.open(closeNow);
+		return () => group.release(closeNow);
+	}, [
+		group,
+		isInGroup,
+		isOpen,
+		closeNow
+	]);
+	const getEnterDelay = () => isInGroup && group.shouldSkipDelay() ? 0 : enterDelay;
+	const ask = (0, react.useCallback)((next, event, delay) => {
+		clear();
+		timer.current = window.setTimeout(() => {
+			const current = latest.current;
+			if (current.isOpen === next) return;
+			if (next && current.isAtPoint) return;
+			if (current.isOpenProp === void 0) {
+				if (next) current.group?.closeActive(event);
+				else current.group?.release(closeNow);
+				setIsOpen(next);
+			}
+			(next ? current.onOpen : current.onClose)?.(event);
+		}, delay);
+	}, [
+		clear,
+		setIsOpen,
+		closeNow
+	]);
+	(0, react.useEffect)(() => clear, [clear]);
+	(0, react.useEffect)(() => {
+		if (!isOpen) return void 0;
+		const handleKeyDown = (event) => {
+			if (event.key === "Escape") ask(false, event, 0);
+		};
+		document.addEventListener("keydown", handleKeyDown);
+		return () => document.removeEventListener("keydown", handleKeyDown);
+	}, [isOpen, ask]);
+	return {
+		isOpen,
+		childHandlers: {
+			onMouseEnter: (event) => {
+				if (shouldOpenOnHover) ask(true, event, getEnterDelay());
+			},
+			onMouseLeave: (event) => {
+				if (shouldOpenOnHover) ask(false, event, leaveDelay);
+			},
+			onFocus: (event) => {
+				if (shouldOpenOnFocus && isKeyboardFocus(event)) ask(true, event, getEnterDelay());
+			},
+			onBlur: (event) => {
+				if (shouldOpenOnFocus) ask(false, event, leaveDelay);
+			},
+			onTouchStart: (event) => {
+				if (shouldOpenOnTouch) ask(true, event, enterTouchDelay);
+			},
+			onTouchEnd: (event) => {
+				if (shouldOpenOnTouch) ask(false, event, leaveTouchDelay);
+			},
+			onTouchCancel: (event) => {
+				if (shouldOpenOnTouch) ask(false, event, leaveTouchDelay);
+			},
+			onPointerDown: (event) => {
+				if (event.pointerType !== "touch") ask(false, event, 0);
+			}
+		},
+		surfaceHandlers: {
+			onMouseEnter: () => {
+				if (shouldOpenOnHover) clear();
+			},
+			onMouseLeave: (event) => {
+				if (shouldOpenOnHover) ask(false, event, leaveDelay);
+			}
+		}
+	};
+}
+// src/Tooltip/Tooltip.tsx
+const MARGIN = 8;
+const GAP = 8;
+const ARROW = 8;
+const TooltipSurface = require_src.styled("div", {
+	name: "Tooltip",
+	label: "Tooltip",
+	shouldForwardProp: (0, _soroush_tech_styled_system_should_forward_prop.createShouldForwardProp)([
+		"layer",
+		"isInteractive",
+		"borderRadius",
+		"bg",
+		"textColor"
+	])
+})(({ theme, layer, isInteractive, borderRadius, bg, textColor }) => ({
+	position: "fixed",
+	...!isInteractive && { pointerEvents: "none" },
+	top: 0,
+	left: 0,
+	visibility: "hidden",
+	zIndex: theme.zOrder[layer],
+	boxSizing: "border-box",
+	maxWidth: "20rem",
+	padding: `${theme.space[.5]} ${theme.space[1]}`,
+	borderRadius: require_getSurfaceRadius.getSurfaceRadius(theme, borderRadius),
+	boxShadow: theme.shadows[4],
+	backgroundColor: (0, require_src.src_exports.get)(theme, `background.${bg ?? "modal"}`),
+	color: (0, require_src.src_exports.get)(theme, `text.${textColor ?? require_themeDefault.themeDefault(theme, "textColor", "initial")}`),
+	fontFamily: (0, require_src.src_exports.get)(theme, "fonts.body"),
+	fontSize: theme.fontSizes[0],
+	lineHeight: (0, require_src.src_exports.get)(theme, "lineHeights.base"),
+	overflowWrap: "break-word"
+}));
+const TooltipDescription = require_src.styled("span", { label: "TooltipDescription" })({
+	position: "absolute",
+	width: 1,
+	height: 1,
+	margin: -1,
+	padding: 0,
+	border: 0,
+	overflow: "hidden",
+	clip: "rect(0 0 0 0)",
+	whiteSpace: "nowrap"
+});
+const TooltipTarget = require_src.styled("span", { label: "TooltipTarget" })({ display: "inline-grid" });
+const TooltipArrow = require_src.styled("span", {
+	name: "Tooltip",
+	slot: "arrow",
+	label: "TooltipArrow"
+})({
+	position: "absolute",
+	width: ARROW,
+	height: ARROW,
+	backgroundColor: "inherit",
+	transform: "rotate(45deg)",
+	pointerEvents: "none"
+});
+const getArrow = ({ anchorRect, surfaceSize, top, left }) => {
+	const { width, height } = surfaceSize;
+	if (top + height <= anchorRect.top + 1 || top >= anchorRect.bottom - 1) {
+		const side = top + height <= anchorRect.top + 1 ? "top" : "bottom";
+		const middle = anchorRect.left + anchorRect.width / 2 - left;
+		return {
+			side,
+			offset: Math.min(Math.max(middle, ARROW), width - ARROW)
+		};
+	}
+	const side = left + width <= anchorRect.left + 1 ? "left" : "right";
+	const middle = anchorRect.top + anchorRect.height / 2 - top;
+	return {
+		side,
+		offset: Math.min(Math.max(middle, ARROW), height - ARROW)
+	};
+};
+const isSameArrow = (a, b) => a !== null && a.side === b.side && a.offset === b.offset;
+const getArrowStyle = ({ side, offset }) => {
+	const half = ARROW / 2;
+	if (side === "top") return {
+		bottom: -4,
+		left: offset - half
+	};
+	if (side === "bottom") return {
+		top: -4,
+		left: offset - half
+	};
+	if (side === "left") return {
+		right: -4,
+		top: offset - half
+	};
+	return {
+		left: -4,
+		top: offset - half
+	};
+};
+const mergeForwarded = (own, forwarded) => Object.fromEntries(Object.entries(forwarded).filter(([, value]) => value !== void 0).map(([name, value]) => {
+	const current = own[name];
+	if (typeof value === "function" && typeof current === "function") return [name, (...args) => {
+		current(...args);
+		value(...args);
+	}];
+	if (name === "aria-describedby" && typeof current === "string" && current) return [name, `${current} ${String(value)}`];
+	return [name, value];
+}));
+const getChildName = (title, own) => {
+	const isHidden = own["aria-hidden"] === true || own["aria-hidden"] === "true";
+	const isNamed = Boolean(own["aria-label"] || own["aria-labelledby"]);
+	return typeof title === "string" && !isHidden && !isNamed ? { "aria-label": title } : {};
+};
+/**
+* @description A short description of one child, shown on hover, keyboard focus and a long touch -
+* a `role="tooltip"` in a `Portal`, placed beside its child and flipped for want of room. The
+* child is named by it (`aria-label`) or described by it (`aria-describedby`, with
+* `shouldDescribeChild`). It opens and closes after their delays, stays open while the pointer is
+* on the tooltip itself, closes on Escape, and never takes or traps the focus.
+*/
+function Tooltip({ children, anchorPosition, title, placement: placementProp, hasArrow: hasArrowProp, enterDelay: enterDelayProp, leaveDelay: leaveDelayProp, enterTouchDelay: enterTouchDelayProp, leaveTouchDelay: leaveTouchDelayProp, shouldDescribeChild: shouldDescribeChildProp, isDescriptionPersistent: isDescriptionPersistentProp, isOpen: isOpenProp, defaultOpen = false, onOpen, onClose, isInteractive: isInteractiveProp, shouldWrapDisabledChild: shouldWrapDisabledChildProp, shouldOpenOnHover: shouldOpenOnHoverProp, shouldOpenOnFocus: shouldOpenOnFocusProp, shouldOpenOnTouch: shouldOpenOnTouchProp, slots, slotProps, layer: layerProp, borderRadius: borderRadiusProp, bg: bgProp, textColor: textColorProp, className, "data-testid": dataTestid, ref: forwardedRef, ...forwarded }) {
+	const dp = require_theme.useDefaultProps("Tooltip");
+	const placement = placementProp ?? dp.placement ?? "top";
+	const hasArrow = hasArrowProp ?? dp.hasArrow ?? false;
+	const shouldDescribeChild = shouldDescribeChildProp ?? dp.shouldDescribeChild ?? false;
+	const isDescriptionPersistent = isDescriptionPersistentProp ?? dp.isDescriptionPersistent ?? false;
+	const isInteractive = isInteractiveProp ?? dp.isInteractive ?? true;
+	const shouldWrapDisabledChild = shouldWrapDisabledChildProp ?? dp.shouldWrapDisabledChild ?? true;
+	const layer = layerProp ?? dp.layer ?? "tooltip";
+	const borderRadius = borderRadiusProp ?? dp.borderRadius;
+	const bg = bgProp ?? dp.bg;
+	const textColor = textColorProp ?? dp.textColor;
+	const id = (0, react.useId)();
+	const isAtPoint = anchorPosition !== void 0;
+	const { isOpen, childHandlers, surfaceHandlers } = useTooltip({
+		isOpen: isOpenProp,
+		defaultOpen,
+		isAtPoint,
+		onOpen,
+		onClose,
+		enterDelay: enterDelayProp ?? dp.enterDelay ?? 100,
+		leaveDelay: leaveDelayProp ?? dp.leaveDelay ?? 0,
+		enterTouchDelay: enterTouchDelayProp ?? dp.enterTouchDelay ?? 700,
+		leaveTouchDelay: leaveTouchDelayProp ?? dp.leaveTouchDelay ?? 1500,
+		shouldOpenOnHover: shouldOpenOnHoverProp ?? dp.shouldOpenOnHover ?? true,
+		shouldOpenOnFocus: shouldOpenOnFocusProp ?? dp.shouldOpenOnFocus ?? true,
+		shouldOpenOnTouch: shouldOpenOnTouchProp ?? dp.shouldOpenOnTouch ?? true,
+		skipDelayDuration: dp.skipDelayDuration
+	});
+	const hasTitle = title !== void 0 && title !== null && title !== "";
+	const isShown = isOpen && hasTitle;
+	const anchorRef = (0, react.useRef)(null);
+	const noAnchorRef = (0, react.useRef)(null);
+	const surfaceRef = (0, react.useRef)(null);
+	const childProps = children?.props ?? {};
+	const forwardedProps = mergeForwarded(childProps, forwarded);
+	const own = {
+		...childProps,
+		...forwardedProps
+	};
+	const isChildDisabled = shouldWrapDisabledChild && own.disabled === true;
+	const childRef = require_useMergedRefs.useMergedRefs(childProps.ref, forwardedRef);
+	const ref = require_useMergedRefs.useMergedRefs(isChildDisabled ? void 0 : anchorRef, childRef);
+	const [arrow, setArrow] = (0, react.useState)(null);
+	const getOrigins = (0, react.useCallback)((context) => require_getTooltipOrigins.getTooltipOrigins(require_getTooltipOrigins.resolveTooltipPlacement(placement, context), context.isRtl), [placement]);
+	const onPlaced = (0, react.useCallback)((placed) => {
+		if (!hasArrow) return;
+		const next = getArrow(placed);
+		setArrow((current) => isSameArrow(current, next) ? current : next);
+	}, [hasArrow]);
+	require_useAnchoredPlacement.useAnchoredPlacement({
+		isOpen: isShown,
+		anchorRef: anchorPosition ? noAnchorRef : anchorRef,
+		anchorPosition,
+		surfaceRef,
+		getOrigins,
+		margin: MARGIN,
+		gap: GAP,
+		onPlaced
+	});
+	const handlers = Object.fromEntries(Object.entries(childHandlers).map(([name, handler]) => [name, (event) => {
+		own[name]?.(event);
+		handler(event);
+	}]));
+	const ownDescription = own["aria-describedby"];
+	const names = getChildName(title, own);
+	const descriptionId = `${id}-description`;
+	const hasPersistentDescription = children !== void 0 && shouldDescribeChild && isDescriptionPersistent && hasTitle;
+	const describedBy = (shown) => hasPersistentDescription ? [ownDescription, descriptionId].filter(Boolean).join(" ") : [ownDescription, shown ? id : void 0].filter(Boolean).join(" ") || void 0;
+	const ariaProps = shouldDescribeChild ? { "aria-describedby": describedBy(isShown) } : names;
+	const child = children ? (0, react.cloneElement)(children, {
+		...forwardedProps,
+		...isChildDisabled || isAtPoint ? {} : handlers,
+		...ariaProps,
+		ref
+	}) : null;
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [
+		isChildDisabled && !isAtPoint ? /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TooltipTarget, {
+			ref: anchorRef,
+			...handlers,
+			children: child
+		}) : child,
+		hasPersistentDescription && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TooltipDescription, {
+			id: descriptionId,
+			children: title
+		}),
+		isShown && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(require_Portal.Portal, { children: /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(TooltipSurface, {
+			...slotProps?.root,
+			as: slots?.root,
+			ref: surfaceRef,
+			id,
+			role: "tooltip",
+			layer,
+			isInteractive,
+			borderRadius,
+			bg,
+			textColor,
+			className: [slotProps?.root?.className, className].filter(Boolean).join(" ") || void 0,
+			"data-testid": dataTestid ?? slotProps?.root?.["data-testid"],
+			...isAtPoint || !isInteractive ? {} : surfaceHandlers,
+			children: [title, hasArrow && arrow ? /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TooltipArrow, {
+				...slotProps?.arrow,
+				as: slots?.arrow,
+				style: {
+					...slotProps?.arrow?.style,
+					...getArrowStyle(arrow)
+				},
+				"aria-hidden": "true"
+			}) : null]
+		}) })
+	] });
+}
+// src/Tooltip/TooltipGroup.tsx
+/**
+* Lets the tooltips inside it open at once, with no enter delay, when the pointer or the focus
+* moves to the next one just after another closed - a toolbar or a rail read from one icon to the
+* next. It renders nothing of its own. Tooltips outside a group are unchanged, a touch keeps its
+* own delay, and a tooltip whose `isOpen` the app controls is left alone: the group neither opens
+* nor closes it, and it does not start the window.
+*/
+function TooltipGroup({ children, skipDelayDuration = 300 }) {
+	const state = (0, react.useMemo)(() => createTooltipGroupState(skipDelayDuration), [skipDelayDuration]);
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TooltipGroupContext.Provider, {
+		value: state,
+		children
+	});
+}
+Object.defineProperty(exports, "Tooltip", {
+	enumerable: true,
+	get: function() {
+		return Tooltip;
+	}
+});
+Object.defineProperty(exports, "TooltipGroup", {
+	enumerable: true,
+	get: function() {
+		return TooltipGroup;
+	}
+});