@cascadia-code/scroll-to-hash-element

中文文档
2.0.3发布于 2024/10/04MITCommonJS零依赖近 30 天下载 1783

检测位置.hash 更改和滚动到带有相应标识的元素。 自定义滚动行为 .

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. 创建散列链接
  4. 自定义滚动行为

滚动到赫什元素

npm GitHub License GitHub package.json dev/peer/optional dependency version

不再需要作为依赖性的反应路线!

此组件启用 散列/锁定链接 以在 React 应用程序内运行.

它通过听 散列财产 window.location 并滚动到匹配元素(如果存在).

这原本是为了解决散列链接不再与 反应路由器 v6+,并且作为依赖而要求的反应路由器。 然而,它被重新设计为与任何路由器合作(或缺乏路由器).

滚动本身由本地浏览器方法提供 元素. scroll Into View ()

安装

用 npm 或纱线安装软件包

npm install @cascadia-code/scroll-to-hash-element

只要把这个组件放置在应用程序的顶层 并在背景中被动工作.

import React from "react";
import ScrollToHashElement from "@cascadia-code/scroll-to-hash-element";

import Header from "./Header";
import Content from "./Content";

const App = () => {
  return (
    <div className="grid">
      <ScrollToHashElement />
      <Header />
      <Content />
    </div>
  );
};

export default App;

使用量

与反应- 路透社

你可以像平常那样创建React-Router链接. 例如,主页上的散列元素的链接就会像这样

<Link to="/#some-div-id">Link Text</Link>

或这个

<Link to="#some-div-id">Link Text</Link>

这样子页面

<Link to="/about#story">Our Story</Link>

无反应- 路透

可以创建标准锚标记. 例如,主页上的散列元素的链接就会像这样

<a href="/#some-div-id">Link Text</a>

或这个

<a href="#some-div-id">Link Text</a>

这样子页面

<a href="/about#story">Our Story</a>

自定义滚动行为

可以通过将道具传递到 Scroll ToHashElement 组件来自定义滚动行为.

<ScrollToHashElement behavior="smooth" inline="center" block="center" />
道具默认选项
behavior"auto""auto", (中文(简体) ), "instant", (中文(简体) ), "smooth"
inline"nearest""center", (中文(简体) ), "end", (中文(简体) ), "nearest", (中文(简体) ), "start"
block"start""center", (中文(简体) ), "end", (中文(简体) ), "nearest", (中文(简体) ), "start"

您可以在此读取更多关于这些属性 : 元素. scroll Into View ()

版本与发布记录

@cascadia-code/scroll-to-hash-element 共发布 6 个版本,首次发布于 2024/05/31;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.0.3latest2024/10/042 年前
2.0.22024/06/022 年前
2.0.12024/06/022 年前
2.0.02024/06/022 年前
1.0.12024/05/312 年前
1.0.02024/05/312 年前

关于 @cascadia-code/scroll-to-hash-element 的常见问题

@cascadia-code/scroll-to-hash-element 是什么?

检测位置.hash 更改和滚动到带有相应标识的元素。 自定义滚动行为 .

如何安装 @cascadia-code/scroll-to-hash-element?

在项目目录运行 npm install @cascadia-code/scroll-to-hash-element,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^16.8.0 || ^17.0.0 || ^18.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@cascadia-code/scroll-to-hash-element 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/cascadia-code__scroll-to-hash-element 是否存在。

@cascadia-code/scroll-to-hash-element 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@cascadia-code/scroll-to-hash-element 可以商用吗?

@cascadia-code/scroll-to-hash-element 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@cascadia-code/scroll-to-hash-element 的下载量有多少?

根据 npm 官方下载统计,@cascadia-code/scroll-to-hash-element 在 2026/10/09 – 2026/11/07 这 30 天内被下载 1,783 次,日均约 59 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cascadia-code/scroll-to-hash-element 还在维护吗?

最新版本 2.0.3 发布于 2024/10/04(2 年前);至今共发布 6 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/05/31。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。