SmartBreadcrumbs 项目教程

SmartBreadcrumbs 项目教程

1. 项目的目录结构及介绍

SmartBreadcrumbs 是一个用于 ASP.NET Core 网站的实用库，旨在轻松添加和自定义面包屑导航。项目的目录结构如下：

SmartBreadcrumbs/
├── examples/
│   └── RazorPagesAndMvc/
├── src/
│   └── SmartBreadcrumbs/
├── tests/
│   └── SmartBreadcrumbs.UnitTests/
├── .gitattributes
├── .gitignore
├── LICENSE
├── OLD_README.md
├── README.md
└── azure-pipelines.yml

目录结构介绍

• examples/: 包含示例项目，展示了如何在 MVC 和 Razor Pages 中使用 SmartBreadcrumbs。

  • RazorPagesAndMvc/: 示例项目，包含 MVC 和 Razor Pages 的页面。

• src/: 项目的源代码目录。

  • SmartBreadcrumbs/: 主要的库代码。

• tests/: 包含单元测试代码。

  • SmartBreadcrumbs.UnitTests/: 单元测试项目。

• .gitattributes: Git 属性文件，用于指定文件的属性。

• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被 Git 管理。

• LICENSE: 项目的开源许可证文件，采用 MIT 许可证。

• OLD_README.md: 旧版本的 README 文件。

• README.md: 项目的 README 文件，包含项目的介绍、使用方法和配置信息。

• azure-pipelines.yml: Azure Pipelines 的配置文件，用于持续集成和部署。

2. 项目的启动文件介绍

SmartBreadcrumbs 是一个库项目，没有传统的启动文件（如 Program.cs 或 Startup.cs）。它的主要功能是通过 NuGet 包集成到 ASP.NET Core 项目中。

使用方法

1. 安装包: 通过 NuGet 安装 SmartBreadcrumbs 包。

   Install-Package SmartBreadcrumbs
   

2. 初始化: 在 ASP.NET Core 项目的 Startup.cs 文件中，配置服务。

   public void ConfigureServices(IServiceCollection services)
   {
       services.AddBreadcrumbs(GetType().Assembly);
   }
   

3. 使用面包屑: 在视图中使用 <breadcrumb></breadcrumb> 标签来渲染面包屑导航。

3. 项目的配置文件介绍

SmartBreadcrumbs 的配置主要通过代码进行，没有独立的配置文件。配置选项可以在初始化时指定。

配置选项

在 Startup.cs 中，可以通过 AddBreadcrumbs 方法传递配置选项：

public void ConfigureServices(IServiceCollection services)
{
    services.AddBreadcrumbs(GetType().Assembly, options =>
    {
        options.TagName = "nav";
        options.TagClasses = "";
        options.OlClasses = "breadcrumb";
        options.LiClasses = "breadcrumb-item";
        options.ActiveLiClasses = "breadcrumb-item active";
        options.SeparatorElement = "<li class=\"separator\">/</li>";
    });
}

配置项说明

• TagName: 面包屑导航的 HTML 标签名，默认为 nav。
• TagClasses: 面包屑导航的 CSS 类。
• OlClasses: 面包屑导航列表的 CSS 类。
• LiClasses: 面包屑导航项的 CSS 类。
• ActiveLiClasses: 当前活动项的 CSS 类。
• SeparatorElement: 面包屑导航的分隔符元素。

通过这些配置项，可以自定义面包屑导航的外观和行为。