Skip to main content

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

PropertyDescriptionDefault
displayContentOnlyAn override for the addon setting with the same name.defaults to the value from badgesConfig
locationsOverride the locations that this badge can appear in.defaults to the value from badgesConfig
priorityThis setting is used to control the order of badges.99
styleThe style options for the badge. Any values not defined will use the addon's baseStyle.defaults to the baseStyle
titleThe text to display on the badge. Can be a string, or a badge functiondefaults to the content portion of the badge (or the whole badge/tag string)
tooltipA 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.