_getHeaderMenu

How to Use `_getHeaderMenu` Method

The _getHeaderMenu method is used to retrieve the main header menu of the application. It leverages caching and local storage to optimize performance, reducing the need for repeated API requests. This method is ideal for loading navigation menus that are frequently accessed by users.

Usage Steps:

Trigger the Method:

This method does not require any input parameters. You simply call the method to retrieve the header menu.

Define a Callback Function:

The callback function is passed as a parameter. This function will be executed once the header menu is retrieved. The retrieved menu data will be passed as an argument to this function.

Handle Retrieved Header Menu:

Inside your callback function, you can process the retrieved menu data. This might involve displaying the menu on the UI, rendering navigation links, or performing other actions based on the menu structure.

Example:

In this example:

The handleHeaderMenu function will be executed once the header menu is retrieved, allowing you to process and display the menu data as needed.

Common Use Cases:

Header Navigation:

Use this method to dynamically load and display the main navigation menu in the header of your application.

Optimized Menu Loading:

This method is useful for optimizing the loading of menus that are frequently accessed, ensuring a faster user experience by caching the data.

Localized Menus:

If your application supports multiple languages, this method will fetch and cache the appropriate menu based on the current language setting.

Notes:

Caching: The method caches the main header menu in memory (_cache_main_menu) and in local storage to improve performance. If the cache is available, it will be used instead of making an API call.

Language-Specific Data: The method retrieves the header menu data based on the current language setting, ensuring that users see the correct version of the menu for their language.

Asynchronous Process: Since the method may involve an API call, the callback function will be executed asynchronously once the data is retrieved.

This method is an efficient way to manage and retrieve the main header menu for your application, providing flexibility in how the menu data is utilized and displayed.

_getHeaderMenu

How to Use _getHeaderMenu Method#

Usage Steps:#

Example:#

Common Use Cases:#

Notes:#

How to Use `_getHeaderMenu` Method

Usage Steps:

Example:

Common Use Cases:

Notes: