6.4 ABP表現層 - 導航欄

每一個WEB應用程式都有導航選單，Abp也為使用者提供了通用的建立和顯示選單方式。

6.4.1 建立選單

一個應用程式可能包含不同的模組，而每個模組都可能有它自己的選單項。在Abp中，需要建立一個派生自NavigationProvider的類來定義一個選單項。

假設我們有一個這樣的主選單：

• Tasks

• Reports

• Administration

  • 1 User Management

  • 2 Role Management

由上可知，Administration選單項有兩個子選單項。對應的生成方法如下：

public class SimpleTaskSystemNavigationProvider : NavigationProvider
{
    public
 
 override void SetNavigation(INavigationProviderContext context)
    {
        context.Manager.MainMenu
            .AddItem(
                new MenuItemDefinition(
                    "Tasks",
                    new LocalizableString("Tasks", "SimpleTaskSystem"),
                    url: "/Tasks",
                    icon: "fa fa-tasks"
 

                    )
            ).AddItem(
                new MenuItemDefinition(
                    "Reports",
                    new LocalizableString("Reports", "SimpleTaskSystem"),
                    url: "/Reports",
                    icon: "fa fa-bar-chart"
                    )
            ).AddItem(
                new
 
 MenuItemDefinition(
                    "Administration",
                    new LocalizableString("Administration", "SimpleTaskSystem"),
                    icon: "fa fa-cogs"
                    ).AddItem(
                        new MenuItemDefinition(
                            "UserManagement",
                            new LocalizableString("UserManagement", "SimpleTaskSystem"),
                            url: "/Administration/Users",
                            icon: "fa fa-users",
                            requiredPermissionName: "SimpleTaskSystem.Permissions.UserManagement"
                            )
                    ).AddItem(
                        new MenuItemDefinition(
                            "RoleManagement",
                            new LocalizableString("RoleManagement", "SimpleTaskSystem"),
                            url: "/Administration/Roles",
                            icon: "fa fa-star",
                            requiredPermissionName: "SimpleTaskSystem.Permissions.RoleManagement"
                            )
                    )
            );
    }
}

MenuItemDefinition可以有一個唯一的名字，一個用於本地化顯示的名字，一個url和一個icon，此外：

• 選單項可能需要與特定使用者許可權相結合顯示選單(請檢視許可權驗證文件)，requiredPermissionName 屬性，可以在這種情況下使用

• 選單項可以依賴於功能項，featureDependency 屬性，可以在這種情況下使用

• 選單項可以定義一個 customData 和 order

InavigationProviderContext方法能夠獲取現有的選單項、新增選單或選單項。因此，不同的模組可以新增各自的選單。

在應用程式中可能有一個或者多個選單，context.Manager.MainMenu 是預設主選單的引用。我們可以使用 context.Manager.Menus 屬性建立和新增更多的選單。

註冊導航提供器

建立完成導航後，我們應該在ABP的 PreInitialize 配置它：

Configuration.Navigation.Providers.Add<SimpleTaskSystemNavigationProvider>();

6.4.2 顯示選單

IUserNavigationManager 可以注入、獲取和顯示選單。因此，我們可以在伺服器端建立選單。

Abp自動生成的 javascript API 使得使用者能夠在客戶端獲取選單，對應的方法和物件在名稱空間 abp.nav 中。例如，在客戶端使用 abp.nav.menus.MainMenu 可以用來獲取主選單。所以我們可以在客戶端建立選單。

ABP模板使用該系統為使用者建立和顯示選單。請試著建立模板並且檢視原始碼以瞭解更多資訊。