跳到主要内容

AppNav

在ChatGPT中打开
Shadow dwc-app-nav dwc-app-nav-item 24.12
Java API

AppNav 组件在 webforJ 中提供一个灵活且有组织的侧边导航菜单,支持扁平化和层次化结构。每个条目都是一个 AppNavItem,可以表示简单链接或包含子项的组。条目可以链接到内部视图或外部资源,并且可以使用图标、徽章或其他组件进行增强。

添加和嵌套项目

AppNavItem 实例用于填充 AppNav 结构。这些项目可以是简单链接或嵌套的组标题,包含子项。没有链接的组标题充当可扩展容器。

使用 addItem() 在导航中添加项目:

AppNavItem dashboard = new AppNavItem("仪表板", "/dashboard");
AppNavItem admin = new AppNavItem("管理员");
admin.addItem(new AppNavItem("用户", "/admin/users"));
admin.addItem(new AppNavItem("设置", "/admin/settings"));

AppNav nav = new AppNav();
nav.addItem(dashboard);
nav.addItem(admin);
连接组项目

导航树中的顶级项目通常意味着可以展开,而不是可点击的链接。在这样的项目上设置 path 可能会让用户感到困惑,因为他们期望它们会展开子项而不是导航到其他地方。

如果您希望组标题触发自定义操作(例如打开外部文档),请保持组路径为空,并在项目后缀中添加交互控件,例如 IconButton。这样可以保持用户体验的一致性和整洁性。

显示代码

连接项目

每个 AppNavItem 可以导航到内部视图或外部链接。您可以使用静态路径或注册的视图类来定义这一点。

静态路径

使用字符串路径直接定义链接:

AppNavItem docs = new AppNavItem("文档", "/docs");
AppNavItem help = new AppNavItem("帮助", "https://support.example.com");

注册的视图

如果您的视图已在 路由器 中注册,可以传递类而不是硬编码的 URL:

AppNavItem settings = new AppNavItem("设置", SettingsView.class);

如果您的注解路由支持 路由参数,您还可以传递 ParametersBag

ParametersBag params = ParametersBag.of("id=123");
AppNavItem advanced = new AppNavItem("用户", UserView.class, params);

带查询参数

传递 ParametersBag 来包含查询字符串:

ParametersBag params = ParametersBag.of("param1=value1&param2=value2");
AppNavItem advanced = new AppNavItem("高级", SettingsView.class, params);
advanced.setQueryParameters(params);

目标行为

使用 setTarget() 控制链接的打开方式。这对于外部链接或弹出式视图特别有用。

  • SELF(默认):在当前视图中打开。
  • BLANK:在新标签或窗口中打开。
  • PARENT:在父浏览上下文中打开。
  • TOP:在顶级浏览上下文中打开。
AppNavItem help = new AppNavItem("帮助", "https://support.example.com");
help.setTarget(AppNavItem.NavigationTarget.BLANK);

前缀和后缀

AppNavItem 支持前缀和后缀组件。使用这些组件提供视觉清晰度,配合图标、徽章或按钮。

  • 前缀:出现在标签之前,适用于图标。
  • 后缀:出现在标签之后,适合徽章或操作。
AppNavItem notifications = new AppNavItem("警报");
notifications.setPrefixComponent(TablerIcon.create("alert"));
notifications.setSuffixComponent(TablerIcon.create("link"));

自动打开组

AppNav 组件上使用 setAutoOpen(true) 来在应用刷新时自动展开嵌套组。

nav.setAutoOpen(true);

样式 AppNavItem

Loading...