Badge Map
The badgeMap
holds all of your badge definitions. It's an object where the keys are badge IDs, and
the values are a BadgeConfig
object containing the following properties:
Badge Config
Property | Description | Default |
displayContentOnly | An override for the addon setting with the same name. | defaults to the value from badgesConfig |
locations | Override the locations that this badge can appear in. | defaults to the value from badgesConfig |
priority | This setting is used to control the order of badges. | 99 |
style | The style options for the badge. Any values not defined will use the addon's baseStyle . | defaults to the baseStyle |
title | The text to display on the badge. Can be a string, or a badge function | defaults to the content portion of the badge (or the whole badge/tag string) |
tooltip | A tooltip to display on hover. | null |
Badge Ordering
Badges are ordered by their priority
, then alphabetically. By default, all badges have a default
priority of 99
to allow others to be sorted before and after easily.
The priority
also dictates which badges can show in the sidebar along
with the value of sidebarDisplayBadges
.