@neo4j-ndl/react
Version:
React implementation of Neo4j Design System
152 lines • 6.59 kB
JavaScript
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
/**
*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import { FloatingOverlay, FloatingPortal } from '@floating-ui/react';
import classNames from 'classnames';
import { createContext, useCallback, useContext, useEffect, useRef, useState, } from 'react';
const SpotlightContext = createContext(null);
export const SpotlightProvider = ({ children, hasOverlay = true, isOverlayTransparent = false, }) => {
const [active, setActive] = useState(null);
const [isOpen, setIsOpen] = useState(false);
const [targets, setTargets] = useState({});
const [targetRect, setTargetRect] = useState(null);
const registerTarget = useCallback((id, ref) => {
setTargets((prev) => (Object.assign(Object.assign({}, prev), { [id]: ref })));
}, []);
const unregisterTarget = useCallback((id) => {
setTargets((prev) => {
const newTargets = Object.assign({}, prev);
delete newTargets[id];
return newTargets;
});
}, []);
// Calculate target element position and size for mask
useEffect(() => {
var _a;
if (active !== null &&
targets[active] !== undefined &&
((_a = targets[active]) === null || _a === void 0 ? void 0 : _a.current) !== null) {
const element = targets[active].current;
const rect = element.getBoundingClientRect();
setTargetRect(rect);
}
else {
setTargetRect(null);
}
}, [active, targets]);
const contextValue = {
hasOverlay,
isActiveSpotlight: useCallback((target) => target === active, [active]),
isOpen,
registerTarget,
registeredTargets: targets,
setActiveSpotlight: useCallback((target) => setActive(target), []),
setIsOpen: useCallback((open) => setIsOpen(open), []),
unregisterTarget,
};
const overlayClasses = classNames('ndl-spotlight-overlay', {
'ndl-spotlight-overlay-opaque': !isOverlayTransparent,
'ndl-spotlight-overlay-open': isOpen && active !== null,
});
const overlayRootRef = useRef(null);
if (active !== null) {
overlayRootRef.current = document.getElementById(active);
}
// Get the border radius from the target element
const getHoleRadius = useCallback(() => {
var _a;
if (active !== null &&
targets[active] !== undefined &&
((_a = targets[active]) === null || _a === void 0 ? void 0 : _a.current) !== null) {
const element = targets[active].current;
const computedStyle = window.getComputedStyle(element);
const borderRadius = computedStyle.borderRadius;
// Parse the border radius value (handle px, rem, em, etc.)
const radiusValue = parseFloat(borderRadius);
return isNaN(radiusValue) ? 0 : radiusValue;
}
return 0;
}, [active, targets]);
const getMaskStyle = () => {
if (!targetRect || isOverlayTransparent) {
return {};
}
const { left, top, width, height } = targetRect;
const x = Math.max(0, left);
const y = Math.max(0, top);
const w = Math.max(0, width);
const h = Math.max(0, height);
const r = Math.max(0, Math.min(getHoleRadius(), Math.min(w, h) / 2));
const vw = window.innerWidth;
const vh = window.innerHeight;
// SVG mask: white = visible overlay, black = hole (transparent)
const svg = `
<svg xmlns="http://www.w3.org/2000/svg" width="${vw}" height="${vh}" viewBox="0 0 ${vw} ${vh}">
<defs>
<mask id="spotlightMask" maskUnits="userSpaceOnUse">
<rect x="0" y="0" width="${vw}" height="${vh}" fill="white"/>
<rect x="${x}" y="${y}" width="${w}" height="${h}" rx="${r}" ry="${r}" fill="black"/>
</mask>
</defs>
<rect x="0" y="0" width="${vw}" height="${vh}" fill="black" mask="url(#spotlightMask)"/>
</svg>`.trim();
const encoded = `data:image/svg+xml;utf8,${encodeURIComponent(svg)}`;
return {
WebkitMaskImage: `url("${encoded}")`,
WebkitMaskRepeat: 'no-repeat',
WebkitMaskSize: `${vw}px ${vh}px`,
maskImage: `url("${encoded}")`,
maskRepeat: 'no-repeat',
maskSize: `${vw}px ${vh}px`,
};
};
/** useEffect to update the target rect, so that the mask tracks the target element */
useEffect(() => {
var _a;
if (active === null) {
return;
}
const el = (_a = targets[active]) === null || _a === void 0 ? void 0 : _a.current;
if (el === null || el === undefined) {
return;
}
const update = () => setTargetRect(el.getBoundingClientRect());
update();
const ro = new ResizeObserver(update);
ro.observe(el);
window.addEventListener('scroll', update, true);
window.addEventListener('resize', update);
return () => {
ro.disconnect();
window.removeEventListener('scroll', update, true);
window.removeEventListener('resize', update);
};
}, [active, targets]);
return (_jsxs(SpotlightContext.Provider, { value: contextValue, children: [hasOverlay && active !== null && isOpen && (_jsx(FloatingPortal, { children: _jsx(FloatingOverlay, { lockScroll: true, className: overlayClasses, style: getMaskStyle(), "data-testid": "ndl-spotlight-overlay" }) })), children] }));
};
export const useSpotlightContext = () => {
const context = useContext(SpotlightContext);
if (context === null) {
throw new Error('Spotlight components must be wrapped in <SpotlightProvider />');
}
return context;
};
//# sourceMappingURL=SpotlightProvider.js.map