@gridui/site-navigation

中文文档
1.1.1发布于 2026/11/01UNLICENSEDTypeScriptES Module

GridUI React site navigation

原始使用文档

@gridui/site-navigation

Landing family. Public API: SiteNavigation, SiteNavigationLink, SiteNavigationProps.

Import components from @gridui/site-navigation and load @gridui/site-navigation/styles.css after Theme. Load styles for any composed dependency used by this family. Applications own routes, labels, state persistence, and branding.

See component ownership and release history.

Rich navigation menus

SiteNavigation combines @gridui/responsive-navigation, @gridui/menu, @gridui/drawer, and @gridui/button. Applications supply links, localized labels, preferences, desktop content, and optional mobile content/footer slots.

ResponsiveNavigation owns desktop/mobile switching. Menu owns content-neutral navigation parts. Drawer owns modal focus management, scroll locking, start/end placement, dismissal, and its header/body/footer parts. The independent Popover family owns desktop hover intent. SiteHeader supplies a separate frame shell with caller-owned branding.

Set columns={1} on a MenuGrid passed as mobile content; the composition does not select its private descendants. Load rendered dependency styles before SiteNavigation styles.

className styles the ResponsiveNavigation root. For a header whose links and preferences form one compact group at the far end, use an application utility class that disables the root's default flex growth:

<SiteHeader justify="between" gap={16} padding={{ base: 24, lg: 32 }}>
    <BrandLink href="/">Product</BrandLink>
    <SiteNavigation className="flex-none" {...localizedNavigation} />
</SiteHeader>

Without that class, the navigation keeps its existing flexible width, placing its preferences at the opposite edge of the available navigation region.

Native navigation and drawer dismissal

links accepts native anchor attributes and handlers in addition to href, label, and current. A caller's onClick runs first on both desktop and mobile. Calling preventDefault() keeps the mobile drawer open. Modified clicks, non-primary clicks, downloads, and links targeting another browsing context retain their native behavior and also leave the drawer open.

An ordinary same-context mobile link closes the drawer. If its destination has a fragment and matches the current origin, path, and query, native anchor navigation keeps the destination focus and scroll position rather than returning focus to the menu trigger. Close-button and Escape dismissal continue to restore trigger focus. onMobileCloseAutoFocus exposes the underlying DrawerPanel event when an application needs another focus policy; calling preventDefault() suppresses the normal trigger restoration. It does not cancel navigation or drawer dismissal.

<SiteNavigation
    links={[
        { href: "#features", label: "Features" },
        { href: "/guide/", label: "Guide", target: "_blank", rel: "noreferrer" },
        { href: "/report.csv", label: "Download report", download: true },
    ]}
    {...navigationLabelsAndPreferences}
/>

Caller-owned mobileContent, mobilePreferences, and mobileFooter slots retain their own activation policy. Compose their controls with public Drawer parts when they should dismiss the panel.

版本与发布记录

@gridui/site-navigation 共发布 4 个版本,首次发布于 2026/10/31;过去 12 个月发布了 4 个版本。

版本发布日期距今
1.1.1latest2026/11/012 天前
1.0.02026/10/313 天前
0.0.02026/10/313 天前
0.0.0-stage2026/10/313 天前

关于 @gridui/site-navigation 的常见问题

@gridui/site-navigation 是什么?

GridUI React站点导航

如何安装 @gridui/site-navigation?

在项目目录运行 npm install @gridui/site-navigation,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^19.2.0)、react-dom(^19.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gridui/site-navigation 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gridui/site-navigation 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@gridui/site-navigation 可以商用吗?

@gridui/site-navigation 使用 UNLICENSED 许可。作者声明为 UNLICENSED,即不授予公开使用许可(与公共领域的 Unlicense 不同)。使用前需获得作者授权。以上为概括,不构成法律意见,请以许可原文为准。

@gridui/site-navigation 还在维护吗?

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