hanav

v2.3.1

Published

a day ago

A React Navigation Menu Component Library.

Downloads

119

0High
0Medium
0Low

wswmsword

navigation-menu navigation-bar nav-bar accessibility spatial-navigation keyboard-navigation react-navbar a11y react-component

hanav

中文 | English

hanav 是一个 React 导航栏组件库，包含一组触发器和一组对应的菜单面板，用户可以通过触发器展开、切换、收起菜单面板。导航栏通常出现在网站的顶部，提供最希望用户访问的链接和其它控件。hanav 有下面这些特性：

🍯 流畅的过渡动画；
🎹 键盘导航（即将支持空间导航）；
♿️ 屏幕阅读器导航；
🎨 高度自定义；
📱 兼容移动端设计；
🚀 开发体验良好。

hanav is a React navigation menu component library that includes a set of triggers and a corresponding set of menu panels. For more information, please refer to the English README or demo.

您可以打开演示链接，查看 hanav 在不同屏幕下的使用效果，或在线编辑 CodeSandbox（），及时看到修改效果。

在地址栏输入 chrome://settings/accessibility，或者在“设置 -> 无障碍”中，可以设置“短暂地突出显示焦点对象”。

Chrome Outer Row

安装和使用

使用 npm 安装 hanav：

npm install hanav

下面是安装之后，使用组件的最简形态，更精美的范例可以打开仓库的 dark-space 文件夹（Next.js 项目）查看：

import { NavBar, Trigger, Item, Content } from "hanav";
export default function MyNavBar() {
  return <NavBar style={{ position: "relative" }}>
    <Trigger style={{ display: "flex", gap: 8 }}>
      <a href="https://github.com/wswmsword/hanav">Repo</a>
      <Item><button>Trigger 1</button></Item>
      <Item><button>Trigger 2</button></Item>
      <Item><button>Trigger 3</button></Item>
    </Trigger>
    <Content className="panelsWrapper">
      <Item><div>Content 1</div></Item>
      <Item><div>
        <a href="https://react.dev/?uwu">React</a> vs
        <a href="https://vuejs.org/?uwu">Vue</a>
      </div></Item>
      <Item><div>Content 3</div></Item>
    </Content>
  </NavBar>;
}

一般，上面的范例更适合桌面端之类的宽屏，移动端使用 hanav 的大致形态可以查看后面的“移动端视图 mini 系列”一节，也可以打开仓库的 dark-space 文件夹查看完整例子。

API

导航栏组件主要由 4 部分组成，分别是 <NavBar>、<Trigger>、<Content> 和 <Item>，此外，<Content> 还包括一些变体用于满足关闭或定制过渡动画的需求。

<Head> 和 <Tail> 用于标记每个菜单面板中可被聚焦的首尾元素，用于优化键盘导航。

对于移动端视图，hanav 提供了 mini 系列，包括 <MiniNavBar>、<MiniTrigger>、<MiniContent>、<MiniItem>、<MiniMenu>、<MiniToggle>、<MiniBack>。

NavBar

导航栏组件的最外层组件，使用的时候具名导入，例如：

import { NavBar } from "hanav";

<NavBar> 会被渲染成 <nav> 作为导航栏组件的最外层，<NavBar> 接收任何用于 HTML 元素的 props，以及下面这些额外选项：

dur，number，定义过渡动画的持续时间（s）；
gap，number，设置面板和触发器之间的距离（px）；
dynamicWidth，boolean，允许面板的宽度变化；
onlyKeyFocus，boolean，设置焦点仅在键盘控制时触发转移；
close，boolean|number，切换面板时跟随触发器的位置。

Trigger

像下面这样导入 <Trigger> 组件：

import { Trigger } from "hanav";

<Trigger> 会被渲染成 <div>，作为 <nav> 的子元素，<Trigger> 接收任何内置的 props。<Trigger> 组件内部是一组触发器，因此可以在 <Trigger> 上传入 className 或 style 来定义触发器的布局。

Content

import { Content } from "hanav";

<Content> 组件内部是一组内容面板，每一个内容面板都按顺序对应了 <Trigger> 组件内部的触发器，<Content> 与 <Trigger> 需要是兄弟节点，<Content> 组件会被渲染成两层 <div>，内层 <div> 用于纵轴动画，外层 <div> 用于整个面板的横轴动画。

<Content> 接收任何内置的 props，这些 props 最终生效在内层 <div> 上，外层 <div> 可以通过 outer 属性传入需要的 props。内层 <div> 用于设置整个面板的样式，外层 <div> 主要用于 hanav 内部对整个面板横向动画的控制。

outer，outer 中的对象会作为 props 传入 <Content> 渲染的外层 <div> 上；
onExpanding，() => void，菜单展开动画开始时调用；
onExpanded，() => void，展开动画结束后调用；
onCollapsing，() => void，收起动画开始时调用；
onCollapsed，() => void，收起动画结束后调用。

Item

import { Item } from "hanav";

<Item> 必须作为 <Trigger> 或 <Content> 的直接子元素，<Item> 在 <Trigger> 中是触发器，在 <Content> 中是内容面板，<Item> 不接收任何参数。

触发器和内容面板成双成对，因此 <Trigger> 和 <Content> 中的 <Item> 数量相等。

<Trigger> 中 <Item> 的内容可以是一个组件或元素，也可以是一个 render prop：

// 组件/元素
<Item><button>Trigger 1</button></Item>
// render prop
<Item>{(props, isOpen) => <button {...props}>Trigger 1</button>}</Item>

render prop 的方式也许对于代码的理解更有帮助，但是不如直接传入组件简洁。render prop 的第一个入参包含了事件、ARIA 标签等必要信息，第二个入参表示展开或收起的状态。

<Item> 在 <Content> 中时，<Item> 的子元素是一个内容面板，子元素 children 同样可以是一个组件/元素，也可以是一个 render prop：

// 组件/元素
<Item><div>
  <a href="https://react.dev/?uwu">React</a> vs
  <a href="https://vuejs.org/?uwu">Vue</a>
</div></Item>
// render prop
<Item>
  {(props, head, tail) => <div {...props} style={{ ...props.style, width: "100%", flexShrink: 0 }}>
    <a href="https://react.dev/?uwu" ref={head}>React</a> vs
    <a href="https://vuejs.org/?uwu" ref={tail}>Vue</a>
  </div>}
</Item>

hanav 需要知晓菜单面板中的首尾可聚焦元素，以此完成键盘导航。从上面的例子可以看到，render prop 形式的子元素提供了 2、3 参数，使用 ref 标记首尾可聚焦元素。组件/元素形式的子元素可以通过引入 <Head/Tail> 组件来声明式标记首尾可聚焦元素。

Head/Tail

import { Head, Tail, MiniHead, MiniTail } from "hanav";

<Head/Tail> 用于 <Content> 下的 <Item> 子元素中，<MiniHead/MiniTail> 用于 <MiniContent> 下的 <MiniItem> 子元素中。它们都是可选的。

它们用于标记每个菜单面板中的首尾可聚焦元素。成功标记后，按下 Enter 打开菜单时，将聚焦菜单的首个可聚焦元素，在菜单中持续 Tab 时，焦点会在首尾可聚焦元素之间循环。

Group

import { Group } from "hanav";

<Group> 只用于 <Trigger> 或后面将介绍的 <MiniTrigger> 中，它可以将多个触发器设为一组，方便添加样式。

关闭动画与自定义 x/y 轴动画

关闭动画很重要，当用户设置了操作系统的“减弱动态效果”后，浏览器可以检测到这个选项，网站的提供者可以根据这个选项，展示无动画效果版本的 hanav：

import { ReducedMotionContent } from "hanav";

<ReducedMotionContent> 使用方法和 <Content> 一致。

hanav 的 x/y 轴默认动效是滑动，开发者可以根据自己的场景，进行 x/y 轴动效的定制。

定制 x 轴动效：

import { CustomXMotionContent } from "hanav";

定制 y 轴动效：

import { CustomYMotionContent } from "hanav";

定制 x 轴和 y 轴动效：

import { CustomMotionContent } from "hanav";

定制动效组件相比 <Content> 额外接受几个属性，分别是 xTrans、yTrans、trans。<CustomMotionContent> 使用 xTrans 和 yTrans 定制 x/y 轴动画，trans 可以被 <CustomXMotionContent> 和 <CustomYMotionContent> 使用定制动画。

xTrans，定制面板切换时的 x 轴过渡动画，传入一个对象，对象的键是 CSS 属性，值是字符串或长度为 2 或 3 的数组，长度 2 的数组表示动画拥有起止两个状态，长度 3 的数组表示动画有进入前、正常、退出后三个状态，除了这两种数组类型，还接受一个特殊的 transition 属性，用于设置切换动画时的过渡时间，值为 false 或字符串，如果不设置将应用默认值，如果设置为 false 将不应用默认值；
yTrans，定制整个面板的收起和展开 y 轴过渡动画，传入一个对象，对象的键是 CSS 属性，值是字符串或长度为 2 的数组，数组值表示动画的起止状态，和 xTrans 一样，yTrans 也接受一个特殊的 transition 属性用于设置动画的过渡时间，同样可以设置为 false 或字符串；
trans，当属性在 <CustomXMotionContent> 时，用法和 xTrans 一致，当属性在 <CustomYMotionContent> 中时，用法和 yTrans 一致。

下面是一个设置 x 轴动画，xTrans 渐变进入、离开的自定义过渡动画例子：

{
  "opacity": [0, 1],
  "transform": ["translate(0)", "translateX(-280px)", "translateX(280px)"]
}

移动端视图 mini 系列

移动端系列组件包括 <MiniNavBar>、<MiniTrigger>、<MiniContent>、<MiniItem>、<MiniMenu>、<MiniToggle>、<MiniBack>。

mini 组件不需要传递任何参数，所以更容易使用。传入的属性，会直接透传到渲染的 dom 元素上。下面是使用 mini 组件的大致形态，完整范例请查看仓库的 dark-space 文件夹：

import { MiniNavBar, MiniTrigger, MiniItem, MiniContent, MiniMenu, MiniToggle, MiniBack } from "hanav";

export default function MyLittleNav() {
  return <MiniNavBar>
    <a>Repo</a>
    <MiniToggle />
    <MiniMenu>
      <MiniTrigger>
        <MiniItem><button>hanav</button></MiniItem>
        <MiniItem><button>postcss-mobile-forever</button></MiniItem>
        <a>about</a>
      </MiniTrigger>
      <MiniContent>
        <MiniItem>{(p, head, tail) => <div {...p}>
          <MiniBack ref={head} />
          <a>Home Page</a>
          <a ref={tail} href="https://github.com/wswmsword/hanav/blob/main/images/wechat-pay.png">Donate</a>
        </div>}</MiniItem>
        <MiniItem><div>
          <a>Home Page</a>
          <MiniBack>Back To Main Menu</MiniBack>
          <a>Bye Bye</a>
        </div></MiniItem>
      </MiniContent>
    </MiniMenu>
  </MiniNavBar>;
}

mini 组件的使用方式和非 mini 组件一致，只需要注意新增的 <MiniToggle> 和 <MiniBack>。

<MiniToggle> 一般用来展示汉堡按钮，控制菜单的展开与收起，它的 children 可以是一个 render prop，入参是菜单是否打开的状态。

<MiniTrigger> 是一个菜单列表，点击其中一项，会进入详情（对应的 <MiniContent> 下的 <MiniItem>），而 <MiniBack> 就是一个从详情返回至菜单列表（<MiniTrigger>）的按钮。

键盘交互

| Key | Description | |:--|:--| | Tab | 当焦点在触发器上，将从前往后逐个聚焦，当焦点在内容面板中，焦点将在头元素和尾元素之间循环 | | Space Enter | 当焦点在触发器上，按下按键，会展开或收起内容面板 | | Esc | 当焦点在内容面板中，按下按键会收起面板，焦点回到触发器 |

注意事项

macOS 里，用户在 Firefox 可能无法使用 Tab 聚焦链接元素，需要用户执行下面的步骤：打开“系统设置”，打开“键盘”，打开“键盘导航”。

开发与维护方向

在项目根目录执行下面的命令，监听组件源码的变化，并实时更新输出：

npm run watch

保持上面的监听命令打开，再打开新的终端会话，执行下面的命令运行引入了源码组件的 React Demo 应用，在更改源码时，在浏览器实时查看效果：

cd examples/demo
npm i
npm run dev

下面的列表是这个项目宏观方向，大概是终端用户、开发者和源码维护三个方面：

可访问性
- 有正确的 ARIA 标签，能够通过安卓 TalkBack 和 iOS、MacOS 的 VoiceOver 的验证
- 能够完全通过键盘控制
- 能够切换打开与关闭过渡动画
- 响应式设计
流畅的过渡动画
不错的性能
良好的开发体验
- 有符合直觉的使用形态
- 保留导航栏功能核心，不侵犯开发者的自定义空间
简易的文档
编码整理
- 无需遵循特定的格式规范，请自由使用习惯的格式
- 编码中的命名合适，在没有找到合适的命名前有详细的注释辅助理解
- 上浮和下沉函数，找到合适的抽象层

查看一些原理。

测试

贡献源码后，首先在测试文件中添加对应的单元测试，然后运行仓库的 dark-space 项目，最后在 hanav 根目录运行测试。

npm run t

CHANGELOG

查看更新日志。

版本规则

查看语义化版本 2.0.0。

协议

查看 MIT License。

支持与赞助

请随意 Issue、PR 和 Star，您也可以支付该项目，支付金额由您从该项目中获得的收益自行决定。

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

hanav

安装和使用

API

NavBar

Trigger

Content

Item

Head/Tail

Group

关闭动画与自定义 x/y 轴动画

移动端视图 mini 系列

键盘交互

注意事项

开发与维护方向

测试

CHANGELOG

版本规则

协议

支持与赞助