@blueprintjs/core
Version:
Core styles & components
76 lines • 3.24 kB
JavaScript
/*
* Copyright 2024 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 React from "react";
import { Classes } from "../../common";
import { OVERLAY2_REQUIRES_OVERLAY_PROVDER } from "../../common/errors";
import { isNodeEnv } from "../../common/utils";
import { OverlaysContext } from "../../context/overlays/overlaysProvider";
import { useLegacyOverlayStack } from "./useLegacyOverlayStack";
/**
* React hook to interact with the global overlay stack.
*
* @see https://blueprintjs.com/docs/#core/hooks/use-overlay-stack
*/
export function useOverlayStack() {
// get the overlay stack from application-wide React context
var _a = React.useContext(OverlaysContext), stack = _a.stack, hasProvider = _a.hasProvider;
var legacyOverlayStack = useLegacyOverlayStack();
var getLastOpened = React.useCallback(function () {
return stack.current[stack.current.length - 1];
}, [stack]);
var getThisOverlayAndDescendants = React.useCallback(function (id) {
var index = stack.current.findIndex(function (o) { return o.id === id; });
if (index === -1) {
return [];
}
return stack.current.slice(index);
}, [stack]);
var resetStack = React.useCallback(function () {
stack.current = [];
}, [stack]);
var openOverlay = React.useCallback(function (overlay) {
stack.current.push(overlay);
if (overlay.props.usePortal && overlay.props.hasBackdrop) {
// add a class to the body to prevent scrolling of content below the overlay
document.body.classList.add(Classes.OVERLAY_OPEN);
}
}, [stack]);
var closeOverlay = React.useCallback(function (id) {
var otherOverlaysWithBackdrop = stack.current.filter(function (o) { return o.props.usePortal && o.props.hasBackdrop && o.id !== id; });
var index = stack.current.findIndex(function (o) { return o.id === id; });
if (index > -1) {
stack.current.splice(index, 1);
}
if (otherOverlaysWithBackdrop.length === 0) {
// remove body class which prevents scrolling of content below overlay
document.body.classList.remove(Classes.OVERLAY_OPEN);
}
}, [stack]);
if (!hasProvider) {
if (isNodeEnv("development")) {
console.error(OVERLAY2_REQUIRES_OVERLAY_PROVDER);
}
return legacyOverlayStack;
}
return {
closeOverlay: closeOverlay,
getLastOpened: getLastOpened,
getThisOverlayAndDescendants: getThisOverlayAndDescendants,
openOverlay: openOverlay,
resetStack: resetStack,
};
}
//# sourceMappingURL=useOverlayStack.js.map