useLinkClickHandler
本页内容

useLinkClickHandler

摘要

参考文档 ↗

处理路由 <Link> 组件的点击行为。如果您需要创建自定义的 <Link> 组件,并希望其具有与我们导出的 <Link> 相同的点击行为,此功能会非常有用。

签名

function useLinkClickHandler<E extends Element = HTMLAnchorElement>(
  to: To,
  {
    target,
    replace: replaceProp,
    state,
    preventScrollReset,
    relative,
    viewTransition,
  }: {
    target?: React.HTMLAttributeAnchorTarget;
    replace?: boolean;
    state?: any;
    preventScrollReset?: boolean;
    relative?: RelativeRoutingType;
    viewTransition?: boolean;
  } = ,
): (event: React.MouseEvent<E, MouseEvent>) => void {}

参数

to

要导航到的 URL,可以是一个字符串或一个部分的 Path

options.preventScrollReset

在使用 ScrollRestoration 组件时,是否阻止在导航完成后将滚动位置重置到视口顶部。默认为 false

options.relative

用于链接的相对路由类型。默认为 "route"

options.replace

是否替换当前的 History 条目,而不是推入一个新条目。默认为 false

options.state

要添加到此导航的 History 条目中的状态。默认为 undefined

options.target

链接的 target 属性。默认为 undefined

options.viewTransition

为此导航启用视图过渡。要在过渡期间应用特定样式,请参阅 useViewTransitionState。默认为 false

返回

一个点击处理函数,可以在自定义的 Link 组件中使用。

文档和示例 CC 4.0
编辑