@vx-oss/heroui-v2-use-aria-modal-overlay 2.2.20-alpha.0

package/LICENSE

@@ -0,0 +1,32 @@
+SPDX-License-Identifier: MIT
+
+The MIT License (MIT)
+
+Parameters
+
+Creator / Maintainer    : Vezham Technologies Private Limited
+Original Author         : NextUI Inc
+Licensor                : Vezham Technologies Private Limited
+
+Copyright © 2025, Vezham Technologies Private Limited. All rights reserved.
+Copyright (c) 2020, NextUI Inc.
+
+---
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,24 @@
+# @vx-oss/heroui-v2-use-aria-modal-overlay
+
+A Quick description of the component
+
+> This is an internal utility, not intended for public usage.
+
+## Installation
+
+```sh
+yarn add @vx-oss/heroui-v2-use-aria-modal-overlay
+# or
+npm i @vx-oss/heroui-v2-use-aria-modal-overlay
+```
+
+## Contribution
+
+Yes please! See the
+[contributing guidelines](https://github.com/heroui-inc/heroui/blob/master/CONTRIBUTING.md)
+for details.
+
+## License
+
+This project is licensed under the terms of the
+[MIT license](https://github.com/heroui-inc/heroui/blob/master/LICENSE).

package/dist/index.d.mts

@@ -0,0 +1,20 @@
+import { AriaModalOverlayProps, ModalOverlayAria } from '@react-aria/overlays';
+import { OverlayTriggerState } from '@react-stately/overlays';
+import { RefObject } from 'react';
+
+interface UseAriaModalOverlayProps extends AriaModalOverlayProps {
+}
+/**
+ * Provides the behavior and accessibility implementation for a modal component.
+ * A modal is an overlay element which blocks interaction with elements outside it.
+ *
+ * This is a modified version from https://vscode.dev/github/adobe/react-spectrum/blob/main/packages/%40react-aria/overlays/src/useModalOverlay.ts#L46
+ *
+ * This implementation disables the prevent scroll when `shouldBlockScroll` prop is false.
+ */
+declare function useAriaModalOverlay(props: (UseAriaModalOverlayProps & {
+    shouldBlockScroll?: boolean;
+}) | undefined, state: OverlayTriggerState, ref: RefObject<HTMLElement>): ModalOverlayAria;
+type UseAriaModalOverlayReturn = ReturnType<typeof useAriaModalOverlay>;
+
+export { type UseAriaModalOverlayProps, type UseAriaModalOverlayReturn, useAriaModalOverlay };

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import { AriaModalOverlayProps, ModalOverlayAria } from '@react-aria/overlays';
+import { OverlayTriggerState } from '@react-stately/overlays';
+import { RefObject } from 'react';
+
+interface UseAriaModalOverlayProps extends AriaModalOverlayProps {
+}
+/**
+ * Provides the behavior and accessibility implementation for a modal component.
+ * A modal is an overlay element which blocks interaction with elements outside it.
+ *
+ * This is a modified version from https://vscode.dev/github/adobe/react-spectrum/blob/main/packages/%40react-aria/overlays/src/useModalOverlay.ts#L46
+ *
+ * This implementation disables the prevent scroll when `shouldBlockScroll` prop is false.
+ */
+declare function useAriaModalOverlay(props: (UseAriaModalOverlayProps & {
+    shouldBlockScroll?: boolean;
+}) | undefined, state: OverlayTriggerState, ref: RefObject<HTMLElement>): ModalOverlayAria;
+type UseAriaModalOverlayReturn = ReturnType<typeof useAriaModalOverlay>;
+
+export { type UseAriaModalOverlayProps, type UseAriaModalOverlayReturn, useAriaModalOverlay };

package/dist/index.js

@@ -0,0 +1,58 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  useAriaModalOverlay: () => useAriaModalOverlay
+});
+module.exports = __toCommonJS(index_exports);
+var import_overlays = require("@react-aria/overlays");
+var import_utils = require("@react-aria/utils");
+var import_react = require("react");
+var import_heroui_v2_use_aria_overlay = require("@vx-oss/heroui-v2-use-aria-overlay");
+function useAriaModalOverlay(props = {
+  shouldBlockScroll: true
+}, state, ref) {
+  let { overlayProps, underlayProps } = (0, import_heroui_v2_use_aria_overlay.useAriaOverlay)(
+    {
+      ...props,
+      isOpen: state.isOpen,
+      onClose: state.close
+    },
+    ref
+  );
+  (0, import_overlays.usePreventScroll)({
+    isDisabled: !state.isOpen || !props.shouldBlockScroll
+  });
+  (0, import_overlays.useOverlayFocusContain)();
+  (0, import_react.useEffect)(() => {
+    if (state.isOpen && ref.current) {
+      return (0, import_overlays.ariaHideOutside)([ref.current]);
+    }
+  }, [state.isOpen, ref]);
+  return {
+    modalProps: (0, import_utils.mergeProps)(overlayProps),
+    underlayProps
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useAriaModalOverlay
+});

package/dist/index.mjs

@@ -0,0 +1,33 @@
+// src/index.ts
+import { ariaHideOutside, usePreventScroll, useOverlayFocusContain } from "@react-aria/overlays";
+import { mergeProps } from "@react-aria/utils";
+import { useEffect } from "react";
+import { useAriaOverlay } from "@vx-oss/heroui-v2-use-aria-overlay";
+function useAriaModalOverlay(props = {
+  shouldBlockScroll: true
+}, state, ref) {
+  let { overlayProps, underlayProps } = useAriaOverlay(
+    {
+      ...props,
+      isOpen: state.isOpen,
+      onClose: state.close
+    },
+    ref
+  );
+  usePreventScroll({
+    isDisabled: !state.isOpen || !props.shouldBlockScroll
+  });
+  useOverlayFocusContain();
+  useEffect(() => {
+    if (state.isOpen && ref.current) {
+      return ariaHideOutside([ref.current]);
+    }
+  }, [state.isOpen, ref]);
+  return {
+    modalProps: mergeProps(overlayProps),
+    underlayProps
+  };
+}
+export {
+  useAriaModalOverlay
+};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@vx-oss/heroui-v2-use-aria-modal-overlay",
+  "version": "2.2.20-alpha.0",
+  "description": "A custom implementation of react aria modal overlay, this removes the prevent scroll",
+  "keywords": [
+    "use-aria-modal-overlay"
+  ],
+  "author": "Vx OSS Devs <oss-developers@vezham.com>",
+  "homepage": "https://vezham.com",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vezham/heroui-v2.git",
+    "directory": "packages/hooks/use-aria-modal-overlay"
+  },
+  "bugs": {
+    "url": "https://github.com/vezham/heroui-v2/issues"
+  },
+  "dependencies": {
+    "@react-aria/overlays": "3.30.0",
+    "@react-aria/utils": "3.31.0",
+    "@react-stately/overlays": "3.6.20",
+    "@vx-oss/heroui-v2-use-aria-overlay": "2.0.5-alpha.0"
+  },
+  "peerDependencies": {
+    "react": ">=18 || >=19.0.0-rc.0",
+    "react-dom": ">=18 || >=19.0.0-rc.0"
+  },
+  "clean-package": "../../../clean-package.config.json",
+  "tsup": {
+    "clean": true,
+    "target": "es2019",
+    "format": [
+      "cjs",
+      "esm"
+    ]
+  },
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsup src --dts",
+    "build:fast": "tsup src",
+    "dev": "pnpm build:fast --watch",
+    "clean": "rimraf dist .turbo",
+    "typecheck": "tsc --noEmit"
+  }
+}