Button

Usage

Buttons allow users to initiate an action or command when clicked. The button's label or text description indicates the purpose of the action to the user. Most of the time, we use the "Default" button type, but other types of buttons may be used to indicate something special about the button's hierarchy or functionality.

Do

Keep button labels succinct with no line breaks.

Don’t

Buttons should never contain line breaks and lose their button shape.

Do

Show focus styles on keyboard :focus

Don’t

Don't remove default button :focus styles.

Do

Use sentence case for labels.

Don’t

Don't use all-caps or other text formats.

Anatomy

Options

Variants

Primary

Primary buttons have top priority in visual hierarchy, and using too many of them on a single view dilutes their effectiveness. We recommend to limit the primary button to one button per view, and place it in the visible section, whenever possible, to indicate its emphasis relative to other actions. Use multiple primary buttons only when the action is repeated in multiple places of the same page. E,g a "Log in" button in the header and in the footer area.

Secondary

Secondary buttons are the default button type. Use them for the main actions on a page or form. Secondary buttons are the most common button type and should be used in most cases. They can be paired with a primary button to perform a secondary action, or used on their own.

Subtle

Subtle buttons have a transparent background with translucent hover and active states, making them useful for compound components like Button Group when paired with secondary or primary variants.

Block

Turning on the block option for button allows the button to span the full width of its container. This feature can be particularly useful when you want the button to occupy more space. Block button can continue to pair with secondary or primary variants.

Trailing and leading icons

You can place an icon inside the button in either the leading or the trailing position to enhance the visual context. It is recommended to use an use an Octicon here.

Use a trailing visual if the button action involves selecting items (dropdown, select, filter, etc), and a leading visual to provide visual context to the adjacent label. E.g. Use a search icon for a search field submit action.

Do

Use a leading icon that provides context and reinforces the label.

Don’t

Don't use a trailing icons to add a visual cue to the label. Use the leading icon for better scanability.

Do

Use a trailing icon for select, dropdown, or filter actions to reinforce its direction.

Don’t

Don't use a leading icon or the arrow for select, dropdown, or filter actions.

Size

Button default to a medium size. Medium is suitable for most interfaces and is considered the preferred size.

Large buttons increase the significance of an action and should be used sparingly. Use the large option when you need to emphasize the button on a big sized heading, for example in a Hero component.

Arrow

The arrow is shown by default in all buttons. Hide the arrow only to save horizontal space or to diminish the importance of the button.

When used in a group, the arrow should be used or hide consistently across all buttons.

Accessibility

Descriptive buttons

Labeling buttons properly lets users know what will happen when they activate the control, lessens errors, and increases confidence.

Read more about descriptive buttons.

Related components

• ButtonGroup: To display a group of related buttons.
• Link: To display a link that navigates to another page.
• Hero: To display a large heading and a description with a ButtonGroup.