@vx-oss/heroui-v2-use-aria-link 2.2.22-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-link
+
+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-link
+# or
+npm i @vx-oss/heroui-v2-use-aria-link
+```
+
+## 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,29 @@
+import { AriaLinkProps } from '@react-types/link';
+import { DOMAttributes, FocusableElement } from '@react-types/shared';
+import { RefObject } from 'react';
+
+interface AriaLinkOptions extends AriaLinkProps {
+    /** Indicates the element that represents the current item within a container or set of related elements. */
+    "aria-current"?: DOMAttributes["aria-current"];
+    /** Whether the link is disabled. */
+    isDisabled?: boolean;
+    /**
+     * The HTML element used to render the link, e.g. 'a', or 'span'.
+     * @default 'a'
+     */
+    elementType?: string;
+}
+interface LinkAria {
+    /** Props for the link element. */
+    linkProps: DOMAttributes;
+    /** Whether the link is currently pressed. */
+    isPressed: boolean;
+}
+/**
+ * Provides the behavior and accessibility implementation for a link component.
+ * A link allows a user to navigate to another page or resource within a web page
+ * or application.
+ */
+declare function useAriaLink(props: AriaLinkOptions, ref: RefObject<FocusableElement>): LinkAria;
+
+export { type AriaLinkOptions, type LinkAria, useAriaLink };

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+import { AriaLinkProps } from '@react-types/link';
+import { DOMAttributes, FocusableElement } from '@react-types/shared';
+import { RefObject } from 'react';
+
+interface AriaLinkOptions extends AriaLinkProps {
+    /** Indicates the element that represents the current item within a container or set of related elements. */
+    "aria-current"?: DOMAttributes["aria-current"];
+    /** Whether the link is disabled. */
+    isDisabled?: boolean;
+    /**
+     * The HTML element used to render the link, e.g. 'a', or 'span'.
+     * @default 'a'
+     */
+    elementType?: string;
+}
+interface LinkAria {
+    /** Props for the link element. */
+    linkProps: DOMAttributes;
+    /** Whether the link is currently pressed. */
+    isPressed: boolean;
+}
+/**
+ * Provides the behavior and accessibility implementation for a link component.
+ * A link allows a user to navigate to another page or resource within a web page
+ * or application.
+ */
+declare function useAriaLink(props: AriaLinkOptions, ref: RefObject<FocusableElement>): LinkAria;
+
+export { type AriaLinkOptions, type LinkAria, useAriaLink };

package/dist/index.js

@@ -0,0 +1,78 @@
+"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, {
+  useAriaLink: () => useAriaLink
+});
+module.exports = __toCommonJS(index_exports);
+var import_utils = require("@react-aria/utils");
+var import_focus = require("@react-aria/focus");
+var import_interactions = require("@react-aria/interactions");
+function useAriaLink(props, ref) {
+  let {
+    elementType = "a",
+    onPress,
+    onPressStart,
+    onPressEnd,
+    onClick,
+    isDisabled,
+    ...otherProps
+  } = props;
+  let linkProps = {};
+  if (elementType !== "a") {
+    linkProps = {
+      role: "link",
+      tabIndex: !isDisabled ? 0 : void 0
+    };
+  }
+  let { focusableProps } = (0, import_focus.useFocusable)(props, ref);
+  let { pressProps, isPressed } = (0, import_interactions.usePress)({
+    onClick,
+    onPress,
+    onPressStart,
+    onPressEnd,
+    isDisabled,
+    ref
+  });
+  let domProps = (0, import_utils.filterDOMProps)(otherProps, { labelable: true, isLink: elementType === "a" });
+  let interactionHandlers = (0, import_utils.mergeProps)(focusableProps, pressProps);
+  let router = (0, import_utils.useRouter)();
+  let routerLinkProps = (0, import_utils.useLinkProps)(props);
+  return {
+    isPressed,
+    // Used to indicate press state for visual
+    linkProps: (0, import_utils.mergeProps)(domProps, routerLinkProps, {
+      ...interactionHandlers,
+      ...linkProps,
+      "aria-disabled": isDisabled || void 0,
+      "aria-current": props["aria-current"],
+      onClick: (e) => {
+        var _a;
+        (_a = pressProps.onClick) == null ? void 0 : _a.call(pressProps, e);
+        (0, import_utils.handleLinkClick)(e, router, props.href, props.routerOptions);
+      }
+    })
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useAriaLink
+});

package/dist/index.mjs

@@ -0,0 +1,59 @@
+// src/index.ts
+import {
+  filterDOMProps,
+  mergeProps,
+  useRouter,
+  useLinkProps,
+  handleLinkClick
+} from "@react-aria/utils";
+import { useFocusable } from "@react-aria/focus";
+import { usePress } from "@react-aria/interactions";
+function useAriaLink(props, ref) {
+  let {
+    elementType = "a",
+    onPress,
+    onPressStart,
+    onPressEnd,
+    onClick,
+    isDisabled,
+    ...otherProps
+  } = props;
+  let linkProps = {};
+  if (elementType !== "a") {
+    linkProps = {
+      role: "link",
+      tabIndex: !isDisabled ? 0 : void 0
+    };
+  }
+  let { focusableProps } = useFocusable(props, ref);
+  let { pressProps, isPressed } = usePress({
+    onClick,
+    onPress,
+    onPressStart,
+    onPressEnd,
+    isDisabled,
+    ref
+  });
+  let domProps = filterDOMProps(otherProps, { labelable: true, isLink: elementType === "a" });
+  let interactionHandlers = mergeProps(focusableProps, pressProps);
+  let router = useRouter();
+  let routerLinkProps = useLinkProps(props);
+  return {
+    isPressed,
+    // Used to indicate press state for visual
+    linkProps: mergeProps(domProps, routerLinkProps, {
+      ...interactionHandlers,
+      ...linkProps,
+      "aria-disabled": isDisabled || void 0,
+      "aria-current": props["aria-current"],
+      onClick: (e) => {
+        var _a;
+        (_a = pressProps.onClick) == null ? void 0 : _a.call(pressProps, e);
+        handleLinkClick(e, router, props.href, props.routerOptions);
+      }
+    })
+  };
+}
+export {
+  useAriaLink
+};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@vx-oss/heroui-v2-use-aria-link",
+  "version": "2.2.22-alpha.0",
+  "description": "Internal hook to handle link a11y and events, this is based on react-aria link hook but without the onClick warning",
+  "keywords": [
+    "use-aria-link"
+  ],
+  "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-link"
+  },
+  "bugs": {
+    "url": "https://github.com/vezham/heroui-v2/issues"
+  },
+  "peerDependencies": {
+    "react": ">=18 || >=19.0.0-rc.0"
+  },
+  "dependencies": {
+    "@react-aria/focus": "3.21.2",
+    "@react-aria/interactions": "3.25.6",
+    "@react-aria/utils": "3.31.0",
+    "@react-types/link": "3.6.5",
+    "@react-types/shared": "3.32.1"
+  },
+  "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"
+  }
+}