Overview
Button-group can contain multiple buttons. Part of the Bolt “Components” CSS framework that powers the Bolt Design System.
Install via NPM
npm install @bolt/components-button-group
Description
Button groups are a horizontal set of actions with a hierarchy that defines the spacing and their relationship between each other. This set of actions help people under stand their options with potential next steps.
Button padding left is 1rem when there are multiple buttons in a horizontal row.
Dos
- Follow the button component guidelnes
- Separate buttons by 1rem
- Make sure the CTAs have a relationship with each other. If they don't reevaluate the content structure.
- Be sure to consider the horizontal group of actions in smaller, less optimal sizes.
- Be sure to determine the hierarchy of the CTAs in the group. These patterns are good:
- Primary + secondary + text button
- Secondary + text button
- Primary + text button
Don'ts
- Don't have multiple primary buttons grouped together
- Don't have LESS than 1rem separating buttons
- Don't have MORE than 1rem separating buttons
- Don't have CTAs grouped together that do not relate to one another.
NOTE: We currently do not have joined buttons (eg, no gap, single button with two sides), but this is something to consider moving forward.
Usage
{% include "@bolt-components-button-group/button-group.twig" with {
buttons: [
{
text: "Learn More",
style: "primary"
},
{
text: "About Pega",
style: "secondary"
}
]
} only %}
Schema
Note: when assigning component props as HTML attributes on a web component, make sure to use kebab-case.
| Prop Name | Description | Type | Default Value | Option(s) |
|---|---|---|---|---|
|
|
Html tag to wrap the button group. |
string
| — |
|
|
|
An array of button objects. |
array
| — |
|
|
|
An array of bolt objects. |
array
| — |
|
|
|
A string of content to place in the button group. |
string
| — |
|