Badges

Documentation and examples for badges, our small count and labeling component.

@@ -33,7 +31,7 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php';

Example

Badges scale to match the size of the immediate parent element by using relative font sizing and em units.

- +

Example heading New

Example heading New

@@ -42,39 +40,39 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php';
Example heading New
Example heading New
- + 
-        		
+
 <h1>Example heading <span class="badge badge-secondary">New</span></h1>
 <h2>Example heading <span class="badge badge-secondary">New</span></h2>
 <h3>Example heading <span class="badge badge-secondary">New</span></h3>
 <h4>Example heading <span class="badge badge-secondary">New</span></h4>
 <h5>Example heading <span class="badge badge-secondary">New</span></h5>
 <h6>Example heading <span class="badge badge-secondary">New</span></h6>
-        		
+
- +

Badges can be used as part of links or buttons to provide a counter.

- +
- + 
 <button type="button" class="button">
   Notifications <span class="badge badge-primary">4</span>
 </button>
- -
+ +

Note that depending on how they are used, badges may be confusing for users of screen readers and similar assistive technologies. While the styling of badges provides a visual cue as to their purpose, these users will simply be presented with the content of the badge. Depending on the specific situation, these badges may seem like random additional words or numbers at the end of a sentence, link, or button.

- +

Unless the context is clear (as with the “Notifications” example, where it is understood that the “4” is the number of notifications), consider including additional context with a visually hidden piece of additional text.

- +

Remember to use aria-label attribute for accessibility in Dolibarr. Don't forget to use aria-hidden on icons included in badges

@@ -84,26 +82,26 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php'; unread messages
- + 
-        		
-        		
+
+
 <button type="button" class="btn btn-primary">
   Profile <span class="badge badge-light" aria-label="9 unread messages" >9</span>
   <span class="sr-only">unread messages</span>
 </button>
-        		
-        		
+
+
- +

Contextual variations

- +

Add any of the below mentioned modifier classes to change the appearance of a badge.

- +
- + Primary Secondary Success @@ -113,10 +111,10 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php'; Light Dark
- + 
-        		
+
 <span class="badge badge-primary">Primary</span>
 <span class="badge badge-secondary">Secondary</span>
 <span class="badge badge-success">Success</span>
@@ -125,22 +123,22 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php';
 <span class="badge badge-info">Info</span>
 <span class="badge badge-light">Light</span>
 <span class="badge badge-dark">Dark</span>
-        		
+
- +
Conveying meaning to assistive technologies
- +

Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .sr-only class.

- - + +

Default status

- +

Add any of the below mentioned modifier classes to change the appearance of a badge to be linked to a default status.

- +
status- @@ -152,14 +150,14 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php'; <span class="badge badge-status" >status</span> - - + +

Pill badges

- +

Use the .badge-pill modifier class to make badges more rounded (with a larger border-radius and additional horizontal padding).

- +
- + Primary Secondary Success @@ -168,16 +166,16 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php'; Info Light Dark - + status - +
- + 
-		
+
 <span class="badge badge-pill badge-primary">Primary</span>
 <span class="badge badge-pill badge-secondary">Secondary</span>
 <span class="badge badge-pill badge-success">Success</span>
@@ -190,15 +188,15 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php';
 <span class="badge badge-pill badge-status" >status</span>
- - - + + +

Dot badges

- +

.dot-pill modifier class to make badges circle.

- +
- + @@ -207,16 +205,16 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php'; - + - +
- + 
-		
+
 <span class="badge badge-dot badge-primary"></span>
 <span class="badge badge-dot badge-secondary"></span>
 <span class="badge badge-dot badge-success"></span>
@@ -229,23 +227,23 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php';
 <span class="badge badge-dot badge-status" ></span>
- - -
+ + +

Note that depending on how they are used, badges may be confusing for users of screen readers and similar assistive technologies. While the styling of badges provides a visual cue as to their purpose, these users will simply be presented with the content of the badge. Depending on the specific situation, these badges may seem like random additional words or numbers at the end of a sentence, link, or button.

- +

Unless the context is clear (as with the “Notifications” example, where it is understood that the “4” is the number of notifications), consider including additional context with a visually hidden piece of additional text.

- +

Remember to use aria-label attribute for accessibility in Dolibarr. Don't forget to use aria-hidden on icons included in badges

-
- - +
+ + - +

Using the contextual .badge-* classes on an <a> element quickly provide actionable badges with hover and focus states.

- +
- + Primary Secondary Success @@ -257,9 +255,9 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php'; status - +
- + 
 <a href="#" class="badge badge-primary">Primary</a>
 <a href="#" class="badge badge-secondary">Secondary</a>
@@ -280,12 +278,12 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php';
 		with html', 'primary') ?>
 		with html', 'danger', 'pill') ?>
 		with html', 'warning', 'dot') ?>
-		
+
 		
 <?php  print dolGetBadge('your label for accessibility', 'your label <u>with</u> <em>html</em>', 'danger', 'pill') ?>
 <?php  print dolGetBadge('your label for accessibility', 'your label <u>with</u> <em>html</em>', 'warning', 'dot') ?>
 		

-		
+
 		
Use status helper function

 		
Using the dolGetStatus function provide in core/lib/functions.lib.php. This function is recommended for code uniformisation and easy maintain

 		with html', 'status4', 6) ?>

 
 		global->MAIN_STATUS_USES_CSS = $saveGlobalConf; ?>
-		
-		
+
+
 				
 <?php print dolGetStatus('your label for accessibility', 'your label', 'your label <u>with</u> <em>html</em>', 'status4') ?>
 <?php print dolGetStatus('your label for accessibility', 'your label', 'your label <u>with</u> <em>html</em>', 'status4',1) ?>
@@ -323,8 +321,8 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php';
 <?php print dolGetStatus('your label for accessibility', 'your label', 'your label <u>with</u> <em>html</em>', 'status4',6) ?>
 		

 
-		
+