馃摚
Have your say in our Mesh survey
Skip to content
Stable

Utility Button

UtilityButton acts as inline page navigation and should always be used in groups of two or more, compared to the Button component which is designed to work as a standalone element and performs the role of a call-to-action (CTA).

Installation

bash
npm install @nib/utility-button

Usage

jsx
import UtilityButton from '@nib/utility-button';

Interactive demo

jsx

Props

PropTypeDefaultDescription
title (required)stringThe main text string of the button.
subtitlestringThe subtitle text string of the button.
iconcomponentAn icon to be displayed on the left of the button. Must be an icon from the @nib/icons package.
showBorderbooleanfalseOption to display a border.
showChevronbooleantrueOption to display the chevron.
truncatebooleanfalseOption to truncate the title and subtitle. Given this component is a CTA truncating the label is not recommended.
hrefstringAdd a link to the button. Note that the component is rendered as an <a> tag in the DOM.
onClickfunctionIf the component is required to carried out some complex functionality other than linking
componentstring or componentWhat to render the utility button as. Should be either a button or a. If onClick is not supplied, will defaults to a

Usage

Components must be wrapped by this Theme

If you require a single button, then use the [Button](/components/button/) component.

Props used on one UtilityButton should be carried through to all other UtilityButtons within the group. So for example, if an icon is included in one UtilityButton, then all UtilityButtons should include an icon. All UtilityButtons used in a group should be uniform.

Be conscious of the number of UtilityButton components you have in a group and the impact that has on available space for the title/subtitle. Within our Container component we've found that 4 - 5 is the most that can comfortably fit. If using icons, this drops down to 3 - 4. If including close to the maximum number of utility buttons be sure to set collapseBelow on the Columns component to xl or xxl.

A UtilityButton should be used on either a white or lightest background. When the UtilityButton is placed on a white background, then border should be shown.

Multiple utility buttons

jsx

Multiple utility buttons with icons

jsx

Note: The Columns and Column with the flex prop is how we achieve equal heights for the utility buttons when the content lengths differ.