默认布局

默认布局所有参数都以 @alain-default- 开头。

使用方式

1、导入样式

src/styles.less 引入:

@import '@delon/theme/layout-default/style/index';

2、使用 layout-default 组件

src/app/layout/basic/basic.component.ts 创建一个新的布局:

import { Component } from '@angular/core';
import { SettingsService, User } from '@delon/theme';
import { LayoutDefaultOptions } from '@delon/theme/layout-default';
import { environment } from '@env/environment';

@Component({
  selector: 'layout-basic',
  template: `
    <layout-default [options]="options" [asideUser]="asideUserTpl" [nav]="navTpl" [content]="contentTpl">
      <layout-default-header-item direction="left">
        <a layout-default-header-item-trigger href="//github.com/ng-alain/ng-alain" target="_blank">
          <i nz-icon nzType="github"></i>
        </a>
      </layout-default-header-item>
      <layout-default-header-item direction="left" hidden="pc">
        <div layout-default-header-item-trigger (click)="searchToggleStatus = !searchToggleStatus">
          <i nz-icon nzType="search"></i>
        </div>
      </layout-default-header-item>
      <layout-default-header-item direction="middle">
        <header-search class="alain-default__search" [toggleChange]="searchToggleStatus"></header-search>
      </layout-default-header-item>
      <layout-default-header-item direction="right" hidden="mobile">
        <header-task></header-task>
      </layout-default-header-item>
      <ng-template #asideUserTpl>
        <div nz-dropdown nzTrigger="click" [nzDropdownMenu]="userMenu" class="alain-default__aside-user">
          <nz-avatar class="alain-default__aside-user-avatar" [nzSrc]="user.avatar"></nz-avatar>
          <div class="alain-default__aside-user-info">
            <strong>{{ user.name }}</strong>
            <p class="mb0">{{ user.email }}</p>
          </div>
        </div>
        <nz-dropdown-menu #userMenu="nzDropdownMenu">
          <ul nz-menu>
            <li nz-menu-item routerLink="/pro/account/center">{{ 'menu.account.center' | i18n }}</li>
            <li nz-menu-item routerLink="/pro/account/settings">{{ 'menu.account.settings' | i18n }}</li>
          </ul>
        </nz-dropdown-menu>
      </ng-template>
      <ng-template #navTpl>
        <layout-default-nav class="d-block py-lg"></layout-default-nav>
      </ng-template>
      <ng-template #contentTpl>
        <router-outlet></router-outlet>
      </ng-template>
    </layout-default>

    <setting-drawer *ngIf="showSettingDrawer"></setting-drawer>
    <theme-btn></theme-btn>
  `,
})
export class LayoutBasicComponent {
  options: LayoutDefaultOptions = {
    logoExpanded: `./assets/logo-full.svg`,
    logoCollapsed: `./assets/logo.svg`,
  };
  searchToggleStatus = false;
  showSettingDrawer = !environment.production;
  get user(): User {
    return this.settings.user;
  }

  constructor(private settings: SettingsService) {}
}

除此之外,在布局的操作都可以通过 SettingsService.notify 来订阅布局的变化(例如:侧边栏的展开与收缩等),注意所有布局相关的变化都会通过这个接口,所以需要做好 filter 操作。

API

layout-default

成员说明类型默认值
[options]选项LayoutDefaultOptions-
[asideUser]侧边用户信息TemplateRef<void>-
[nav]导航信息TemplateRef<void>-
[content]内容信息TemplateRef<void>-
[customError]自定义异常路由错误消息,当 null 时表示不显示错误消息string, nullCould not load ${evt.url} route

LayoutDefaultOptions

成员说明类型默认值
[logo]自定义 Logo 区域TemplateRef<void>-
[logoExpanded]展开时 Logo 地址string./assets/logo-full.svg
[logoCollapsed]收缩时 Logo 地址string./assets/logo.svg
[logoFixWidth]指定固定 Logo 宽度number-
[logoLink]指定 Logo 路由地址string/
[hideAside]隐藏侧边栏,同时不显收缩图标按钮booleanfalse

layout-default-nav

成员说明类型默认值
[disabledAcl]acl 校验失败时以 disabled 状态显示booleanfalse
[autoCloseUnderPad]小于Pad宽度时路由切换后自动关闭侧边栏booleantrue
[recursivePath]自动向上递归查找,菜单数据源包含 /ware,则 /ware/1 也视为 /warebooleantrue
[openStrictly]展开完全受控,不再自动关闭已展开的项booleanfalse
[maxLevelIcon]Icon最多显示到第几层number3
(select)点击菜单时回调(包含 disabledEventEmitter<Menu>-

组件的数据来自 MenuService(其结构为 Menu), MenuService 的操作会自动同步至该组件。

layout-default-header-item

成员说明类型默认值
[hidden]隐藏行为pc, mobile, nonenones
[direction]方向left, middle, rightright

layout-default-header-item-trigger

头部项的触发样式。

布局说明

按上-左-右布局方式,运用于业务页的开发。其规范细节:

  • 顶部区域高度 64px(参数:@header-hg

  • 侧边区域宽度 200px(参数:@aside-wd

    • 当屏幕低于 1140px 宽时隐藏侧边导航

    • 当屏幕低于 1140px 宽时打开侧边导航为 fixed 状态

    • 主要包括一个 layout-default-nav 组件

参数是指可以通过 src/styles/theme.less 文件按需要调整。

顶部区域

位置:src/app/layout/base/widgets

脚手架默认提供了一些常规顶部区域组件,这些组件都存放于 components 目录中。同时 @delon/abc 也提供若干顶部组件(例如:notice-icon 通知菜单组件)。你可以根据提供的组件自行组合或自行开发。

脚手架支持响应式布局,对于顶部区域可能会是在小屏幕下需要隐藏一些组件,因此你可以在对应的DOM节点上加上 hidden-xs 表示当屏幕小于 768px 时自动隐藏。

侧边区域

位置:src/app/layout/default/sidebar

只包括一个用户信息和主菜单。主菜单是一个 layout-default-nav

内部区域

内容区域是业务页区域,规范细节:

  • 内容距离页面标准、侧边、右边滚动条、底部,这四边距依一个标准Dashboard的Gutter宽度 24px

样式参数

名称默认值功能
@alain-default-prefix.alain-default布局样式前缀
@alain-default-easecubic-bezier(.25, 0, .15, 1)动画过滤函数
@alain-default-header-hg64px顶部高度
@alain-default-header-bg@primary-color顶部背景色
@alain-default-header-padding@layout-gutter * 2顶部左右内边距
@alain-default-header-search-enabledtrue是否开启顶部搜索框
@alain-default-header-icon-fs18px顶部 Icon 大小
@alain-default-header-logo-max-height36pxLogo 图最高高度
@alain-default-aside-wd200px侧边栏宽度
@alain-default-aside-bg#fff侧边栏背景色
@alain-default-aside-scrollbar-width0侧边栏滚动条宽度
@alain-default-aside-scrollbar-height0侧边栏滚动条高度
@alain-default-aside-scrollbar-track-colortransparent侧边栏滚动条的轨道颜色
@alain-default-aside-scrollbar-thumb-colortransparent侧边栏滚动条小方块颜色
@alain-default-aside-nav-fs14px侧边栏菜单字号
@alain-default-aside-nav-icon-width14px侧边栏菜单 ICON 宽度
@alain-default-aside-nav-img-wh14px侧边栏菜单图像宽高
@alain-default-aside-nav-padding-top-bottom@layout-gutter侧边栏菜单项上下内边距
@alain-default-aside-nav-item-height38px侧边栏菜单项高度
@alain-default-aside-nav-text-colorrgba(0, 0, 0, 0.65)侧边栏菜单文本颜色
@alain-default-aside-nav-text-hover-color#108ee9侧边栏菜单文本悬停颜色
@alain-default-aside-nav-group-text-colorrgba(0, 0, 0, 0.43)侧边栏菜单分组文本颜色
@alain-default-aside-nav-selected-text-color#108ee9侧边栏菜单激活时文本颜色
@alain-default-aside-nav-selected-bg#fcfcfc侧边栏菜单激活时背景颜色
@alain-default-aside-collapsed-wd@layout-gutter * 8侧边栏收缩后宽度
@alain-default-aside-collapsed-nav-fs24px侧边栏收缩后文本字号
@alain-default-aside-collapsed-nav-img-wh24px侧边栏收缩后图像宽高
@alain-default-content-heading-bg#fafbfc内容区域标题背景色
@alain-default-content-heading-border#efe3e5内容区域标题底部边框色
@alain-default-content-padding@layout-gutter * 3内容区域内边距
@alain-default-content-bg#f5f7fa内容区域背景色
@alain-default-widget-app-icons-enabledtrue是否 app-icon 小部件样式
@alain-default-aside-user-enabledtrue是否侧边栏用户信息样式

常见问题

为什么会有两个快捷菜单

快捷菜单生成规则统一在 0 索引下查找,并按以下顺序来获取:

  1. 【推荐】 children 存在 shortcutRoot: true 则最优先

  2. 否则查找带有【dashboard】字样链接,若存在则在此菜单的下方创建快捷入口

  3. 否则放在0节点位置

因此,建议在菜单数据的 0 索引下保持一个有效的 shortcutRoot: true 数据。

常见问题

隐藏主菜单项

表示永远不显示菜单,可以在菜单设置 hide: true

隐藏自动生成导航隐藏面包屑

表示不显示该节点,可以在菜单设置 hideInBreadcrumb: true

关于层级

虽然支持无限层级,但为了用户体验请保持最多不超过四层(含组别)。

如何更新某个菜单项

当调用 MenuService.setItem(key, newValue) 时会自动重新渲染主菜单,其中 key 必须是存在值,请参考 Menu 的定义。

如何控制菜单展开

利用 SettingsService.setLayoutcollapsed 进行操作,例如:

SettingsService.setLayout('collapsed', status);