跳到主要内容

AppLayout

在ChatGPT中打开
Shadow dwc-app-layout 23.06
Java API

AppLayout 是一个全面响应式的布局组件，提供了头部、底部、抽屉和内容区域。头部和底部是固定的，抽屉从视口中滑入和滑出，内容区域是可滚动的。

此组件可用于构建常见的应用布局，例如仪表板。

特性​

webforJ 应用布局是一个允许构建常见应用布局的组件。

  • 易于使用和自定义
  • 响应式设计
  • 多个布局选项
  • 与 webforJ 深色模式兼容

它提供了一个头部、一个底部、一个抽屉和一个内容区域，全部构建在一个响应式组件中，可以轻松自定义以快速构建常见的应用布局，如仪表板。头部和底部是固定的，抽屉从视口中滑入和滑出，内容区域是可滚动的。

布局的每个部分都是一个 Div，可以包含任何有效的 webforJ 控件。为了获得最佳效果，应用应该包含一个包含 viewport-fit=cover 的视口元标签。该元标签使视口缩放以填满设备显示。

@AppMeta(name = "viewport", content = "width=device-width, initial-scale=1.0, viewport-fit=cover, user-scalable=no")

概述​

以下代码示例将生成一个带可折叠侧边栏的应用，其中包含一个徽标和多个内容选项的标签及一个头部。演示使用 dwc-icon-button 网页组件创建抽屉切换按钮。该按钮具有 data-drawer-toggle 属性，指示 DwcAppLayout 监听来自该组件的点击事件，以切换抽屉状态。

显示代码

全宽导航栏​

默认情况下，AppLayout 在离屏模式下渲染头部和底部。离屏模式意味着头部和底部的位置将被移位以适应打开的抽屉。禁用此模式将导致头部和底部占用全部可用空间，并使抽屉的顶部和底部位置与头部和底部相适应。

AppLayout myApp = new AppLayout();

myApp.setHeaderOffscreen(false);
myApp.setFooterOffscreen(false);
显示代码

多个工具栏​

导航栏中可以添加的工具栏数量没有限制。Toolbar 是一个水平容器组件，包含一组操作按钮、图标或其他控件。要添加附加工具栏，只需使用 addToHeader() 方法添加另一个 Toolbar 组件。

以下演示展示了如何使用两个工具栏，第一个工具栏包含抽屉的切换按钮和应用的标题，第二个工具栏包含一个二级导航菜单。

显示代码

固定工具栏​

固定工具栏是在用户向下滚动时仍然在页面顶部可见的工具栏，但导航栏的高度被折叠以为页面内容提供更多空间。通常，这种工具栏包含与当前页面相关的固定导航菜单。

可以使用 CSS 自定义属性 --dwc-app-layout-header-collapse-height 和 AppLayout.setHeaderReveal() 选项来创建固定工具栏。

当调用 AppLayout.setHeaderReveal(true) 时，头部将在第一次渲染时可见，随后在用户开始向下滚动时隐藏。一旦用户开始向上滚动，头部将重新显示。

借助 CSS 自定义属性 --dwc-app-layout-header-collapse-height，可以控制头部导航栏隐藏的程度。

显示代码

移动导航布局​

底部导航栏可用于提供应用底部的不同版本的导航。这种类型的导航在移动应用中尤其受欢迎。

请注意，以下演示中抽屉是隐藏的。AppLayout 小部件支持三种抽屉位置：DrawerPlacement.LEFT、DrawerPlacement.RIGHT 和 DrawerPlacement.HIDDEN。

与 AppLayout.setHeaderReveal() 一样，AppLayout.setFooterReveal() 也受支持。当调用 AppLayout.setFooterReveal(true) 时，底部在首次渲染时可见，然后在用户开始向上滚动时隐藏。一旦用户开始向下滚动，底部将重新显示。

默认情况下，当屏幕宽度为 800px 或更小时，抽屉将切换为弹出模式。 这称为断点。弹出模式意味着抽屉将在内容区域上方弹出，带有覆盖层。可以通过使用 setDrawerBreakpoint() 方法配置断点，断点必须是有效的 媒体查询。

显示代码

抽屉工具​

AppLayout 抽屉工具旨在用于主应用布局中的集成导航和上下文菜单，而独立的 Drawer 组件提供灵活的、独立的滑动面板，可以在应用的任何地方用于附加内容、过滤器或通知。本节重点介绍 AppLayout 提供的内置抽屉功能和工具。

抽屉断点​

默认情况下，当屏幕宽度为 800px 或更小时，抽屉将切换为弹出模式。这被称为断点。弹出模式意味着抽屉将在内容区域上方弹出，带有覆盖层。可以通过使用 setDrawerBreakpoint() 方法配置断点，断点必须是有效的媒体查询。

例如，在以下示例中，抽屉断点配置为 500px 或更小。

AppLayout demo = new AppLayout();
demo.setDrawerBreakpoint("(max-width:500px)");

抽屉标题​

AppLayout 组件提供了 addToDrawerTitle() 方法，用于定义要在抽屉头部显示的自定义标题。

layout.addToDrawerTitle(new Div("菜单"));

抽屉操作​

AppLayout 组件允许您将自定义组件，例如按钮或图标，放置到 抽屉头部操作区域 中，使用 addToDrawerHeaderActions() 方法。

layout.addToDrawerHeaderActions(
    new IconButton(TablerIcon.create("bell")),
);

可以传递多个组件作为参数：

layout.addToDrawerHeaderActions(
    new IconButton(TablerIcon.create("bell")),
    new Button("个人资料")
);

抽屉操作出现在抽屉头部的 右对齐部分。

显示代码

AppDrawerToggle 24.12​

AppDrawerToggle 组件是一个服务器端的 webforJ 类，表示一个用于切换 AppLayout 中导航抽屉可见性的按钮。它映射到客户端的 <dwc-app-drawer-toggle> 元素，并默认样式为类似传统汉堡菜单图标的样式，该行为可以自定义。

概述​

AppDrawerToggle 扩展了 IconButton，并默认使用 Tabler 图标集中的 "menu-2" 图标。它会自动应用 data-drawer-toggle 属性以与客户端侧抽屉行为集成。

// 无需事件注册：
AppLayout layout = new AppLayout();
layout.addToHeader(new AppDrawerToggle());
// 抽屉切换将开箱即用，无需手动事件监听器。

样式​

Loading...