Sorting Navigation Elements

This documentation describes how the navigation elements are sorted and how to change this default behaviour.

  • When you want to add the Navigation Element you can use the RoutesService. For more details, see the document.
  • However, in this documentation, we will talk more about how to sort the navigation elements.

Order Property

  • Normally, you are able to sort your routes with this property. But you can customize our default sorting algorithm.

Default Sorting algorithm

  • To see our default sorting algorithm click here. What does this function do?
    • if the order property is defined, then it will be sorted by the order value.
    • if both of the navigation elements have the same order value then it will be sorted by the name.
    • If the order property is not defined, it will be the last element and the unordered navs will be sorted by name.

How to Customize

in app.module.ts

import { SORT_COMPARE_FUNC } from "@abp/ng.core";

@NgModule({
  providers: [
    ...{
      provide: SORT_COMPARE_FUNC,
      useFactory: yourCompareFuncFactory,
    },
  ],
  // imports, declarations, and bootstrap
})
export class AppModule {}

Contributors


Last updated: July 31, 2024 Edit this page on GitHub

Was this page helpful?

Please make a selection.

To help us improve, please share your reason for the negative feedback in the field below.

Please enter a note.

Thank you for your valuable feedback!

Please note that although we cannot respond to feedback, our team will use your comments to improve the experience.

In this document
Community Talks

Building Modular Monolith Applications Using .NET and ABP Framework

17 Oct, 17:00
Online
Register Now
Mastering ABP Framework Book
Mastering ABP Framework

This book will help you gain a complete understanding of the framework and modern web application development techniques.

Learn More