_findCategoryTreeById

How to Use `_findCategoryTreeById` Method

The _findCategoryTreeById method retrieves a category tree or a specific category within the tree by its ID. It utilizes caching and local storage to optimize performance, reducing the need for repeated API calls. You can use this method to get category data for various purposes, such as displaying a category structure or navigating through categories.

Usage Steps:

Provide the categoryId:

The first parameter is the categoryId, which is the unique identifier for the category you want to retrieve. If you pass null or omit this parameter, the method will return the entire category tree instead of a specific category.

Define a Callback Function:

The second parameter is a callback function. This function will be executed once the category data is retrieved. The retrieved data (either the entire category tree or the specific category) will be passed as an argument to this function.

Handle Retrieved Data:

Inside your callback function, you can process the retrieved category data. This might involve rendering the categories on the UI, navigating to a specific category, or performing other actions based on the category information.

Example:

In this example:

The categoryId is "12345". Replace this with the actual ID of the category you want to retrieve. If you want to retrieve the entire category tree, pass null instead.

The handleCategoryData function will be executed once the category data is retrieved, allowing you to process the data as needed.

Common Use Cases:

Category Navigation:

Use this method when building category navigation menus, allowing you to fetch and display subcategories dynamically.

Category Selection in Forms:

This method is useful for forms where users need to select a category. You can retrieve the entire category tree and display it in a dropdown or selection component.

Optimized Loading:

By leveraging caching and local storage, this method reduces the need for repeated API calls, making it ideal for scenarios where category data is frequently accessed but doesn't change often.

Notes:

Caching: The method caches the category tree in memory (_cache_category_tree) 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 category data based on the current language setting, ensuring that users see the correct language version of the categories.

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 a powerful tool for retrieving and working with category data, allowing you to efficiently manage category structures within your application.

_findCategoryTreeById

How to Use _findCategoryTreeById Method#

Usage Steps:#

Example:#

Common Use Cases:#

Notes:#

How to Use `_findCategoryTreeById` Method

Usage Steps:

Example:

Common Use Cases:

Notes: