SuperAPI AI 工具集

syncfusion-angular-breadcrumb

前端与建站

查看项目

更新于 10-15 15:33

技能介绍

用途

Syncfusion Angular Breadcrumb 组件(标签为 ejs-breadcrumb)提供面包屑导航,用于显示用户在当前页面层级结构中的位置,并以可点击链接的形式呈现通往父级层级的路径。它属于 @syncfusion/ej2-angular-navigations 包。

适用场景包括:在 Angular 应用中实现面包屑导航轨迹、显示用户在页面层级中的位置、支持跳转到父级区块、为面包屑项添加图标与视觉增强、在空间受限时处理溢出、通过模板自定义外观、为面包屑项配置数据绑定。

主要能力

  • 多种数据绑定方式:以指令形式定义 items、基于当前 URL 生成、静态 URL 配置,以及通过 url 属性绑定导航路径。
  • 图标支持:字体图标(iconCss)、图片图标、SVG 图标;支持图标左右定位、仅图标无文字、仅首项显示图标等模式。
  • 导航控制:enableNavigation 控制是否可点击导航,enableActiveItemNavigation 控制最后一项(活动项)是否可点击,支持相对/绝对 URL、在新标签页或页面中打开。
  • 溢出处理:通过 maxItems 与 overflowMode 配置,提供 Collapsed(折叠)、Menu(下拉菜单)、Wrap(换行)、Scroll(横向滚动)、Hidden(动态隐藏)、None(不处理)共 6 种模式。
  • 模板自定义:itemTemplate 自定义项渲染,separatorTemplate 自定义分隔符(含自定义分隔符图标与样式),支持条件模板与组件集成(如 ChipList)。
  • 事件处理:beforeItemRender 事件用于动态自定义渲染前的项。
  • 其他属性:cssClass 用于样式定制;组件提供 destroy 等方法。

使用方式

安装与模块导入:从 @syncfusion/ej2-angular-navigations 导入 BreadcrumbModule,并可从 @syncfusion/ej2-base 调用 enableRipple(true)。需引入相应 CSS 并应用主题。

基础示例(来自资料):

import { BreadcrumbModule } from '@syncfusion/ej2-angular-navigations';
import { Component } from '@angular/core';
import { enableRipple } from '@syncfusion/ej2-base';

enableRipple(true);

@Component({
  imports: [BreadcrumbModule],
  standalone: true,
  selector: 'app-root',
  template: `<div class="e-section-control">
    <ejs-breadcrumb [enableNavigation]="true">
      <e-breadcrumb-items>
        <e-breadcrumb-item iconCss="e-icons e-home" url="url"></e-breadcrumb-item>
        <e-breadcrumb-item text="Products" url="url"></e-breadcrumb-item>
        <e-breadcrumb-item text="Electronics" url="url"></e-breadcrumb-item>
        <e-breadcrumb-item text="Laptops" url="url"></e-breadcrumb-item>
      </e-breadcrumb-items>
    </ejs-breadcrumb>
  </div>`
})
export class AppComponent {}

常见用法:

  • 禁用导航:<ejs-breadcrumb [enableNavigation]="false">
  • 添加图标:<e-breadcrumb-item iconCss="e-icons e-home" text="Home"></e-breadcrumb-item>
  • 处理溢出:<ejs-breadcrumb [maxItems]="3" overflowMode="Menu">
  • 启用最后一项导航:<ejs-breadcrumb [enableActiveItemNavigation]="true">
  • 自定义分隔符:使用 #separatorTemplate 模板,例如 <span class='e-bicons e-arrow'></span>

关键属性(资料所列):items(数组,BreadcrumbItemModel 项)、url(字符串,静态 URL 生成项)、enableNavigation(布尔,默认 true)、enableActiveItemNavigation(布尔,默认 false)、maxItems(数字)、overflowMode(字符串,默认 'Menu')、itemTemplate、separatorTemplate、cssClass、beforeItemRender(事件)。

适用场景

  • 电商导航:展示商品层级(Home > Categories > Subcategory > Product)
  • 文件系统浏览:显示文件夹路径并可访问父文件夹
  • 文档站点:在文档层级中显示面包屑轨迹
  • 博客导航:显示文章分类与当前文章位置
  • 后台管理面板:显示区块与子区块位置
  • 多步骤表单:显示表单进度与完成步骤

限制

资料未提供关于收费、价格、平台兼容版本、性能效果或具体使用步骤的更多信息,相关内容暂未提供。