Enable Navbar Badges

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

How-to Guide

Author:

Fluent Commerce

Changed on:

13 Dec 2023

Key Points

Overview
Who is this guide for?
Steps to enable navigation bar badges with an example

Steps

Overview

The navigation bar badge displays a count of items for a particular page. It should represent the outstanding actions that need to be performed.For example, the Waves page can be configured to show the outstanding orders that need to be allocated.The navigation bar badge is configurable via manifest taking a GraphQL query.

Who is this guide for?

Who is this guide for? This guide will teach you how to configure navigation bar badges in your OMX Web App(s). It is only relevant if you have the requirement to display outstanding items for a particular page.

Steps to enable navigation bar badges with an example

Note

Users can use the navigation bar badge to see the number of in-progress Waves in the Fluent Store.In the following example, navigation bar badges will be configured using the UI Builder Configuration Guide for the Fluent Store Waves page to show the total number of in-progress Waves. This is a variation on the reference solution in the getting started manifests. In that example, the Waves badge displays the Fulfilments that need to be picked.

Step 1

Find the relevant queryName from GraphQL Schema queries.For Example, `waves` queryName will show data about waves.

Step 2: Set the variables

A property used to access `waves` query to filter data. For Example: `processingLocation {ref}` is taken to filter data according to the location.
In-progress Waves contain waves with the status pick, pack, and dispatch. Hence, set the `status` to `PICK`,`PACK`,`DISPATCH`.

Step 3. Set thresholds values (Optional)

Set thresholdLow value = `Any Number` to show a green color badge if the result is less than this threshold. For Example, 3 (If the result is less than 3, the badge will be green color.)
Set thresholdHigh value = `Any Number` to show a red color badge if the result is more than this threshold. For Example, 5 (If the result is more than 5, the badge will be red color but if the result is between 3 and 5 the badge will be orange.)

Step 4. Put the badge configuration in nav object of the waves page manifest.i.e. fc.mystique.manifest.store.fragment.waves.

1"nav": {
2                "label": "i18n:fc.sf.ui.waves.index.nav",
3                "icon": "store",
4                "badge": {
5                    "queryName": "waves",
6                    "variables": {
7                        "processingLocation": {
8                            "ref": "{{activeLocation.ref}}"
9                        },
10                        "status": [
11                            "PICK",
12                            "PACK",
13                            "DISPATCH"
14                        ]
15                    },
16                    "thresholds": {
17                        "thresholdHigh": 5,
18                        "thresholdLow": 3
19                    }
20                }
21            }

The image displays '7' results on the In Progress Waves dashboard tile.
The image displays the result count of 7 from the `waves` GraphQL query on Waves navigation bar badge.
The count '7' is above thresholdHigh which is why the color of the badge is red.

Step 4. Put the badge configuration in nav object of the waves page manifest.i.e. fc.mystique.manifest.store.fragment.waves.

1"nav": {
2                "label": "i18n:fc.sf.ui.waves.index.nav",
3                "icon": "store",
4                "badge": {
5                    "queryName": "waves",
6                    "variables": {
7                        "processingLocation": {
8                            "ref": "{{activeLocation.ref}}"
9                        },
10                        "status": [
11                            "PICK",
12                            "PACK",
13                            "DISPATCH"
14                        ]
15                    },
16                    "thresholds": {
17                        "thresholdHigh": 5,
18                        "thresholdLow": 3
19                    }
20                }
21            }

The image displays '7' results on the In Progress Waves dashboard tile.
The image displays the result count of 7 from the `waves` GraphQL query on Waves navigation bar badge.
The count '7' is above thresholdHigh which is why the color of the badge is red.

Enable Navbar Badges

Key Points