@commercetools-uikit/primary-button

Buttons: Primary Button

Description

Primary buttons are used for a primary action on a page. You must also pass a label for accessibility reasons.

Usage

import PrimaryButton from '@commercetools-uikit/primary-button';

<PrimaryButton
  iconLeft={<InformationIcon />}
  label="Alerts a message"
  onClick={() => alert('Button clicked')}
/>;

Properties

Props	Type	Required	Values	Default	Description
type	oneOf	-	submit, reset, button	button	Used as the HTML type attribute.
label	string	✅	-	-	Should describe what the button does, for accessibility purposes (screen-reader users)
buttonAttributes	object	-	-	-	Allows setting custom attributes on the underlying button html element
iconLeft	node	✅	-	-	The left icon displayed within the button
isToggleButton	bool	✅	-	false	If this is active, it means the button will persist in an "active" state when toggled (see isToggled), and back to normal state when untoggled
isToggled	bool	-	-	-	Tells when the button should present a toggled state. It does not have any effect when isToggleButton is false
isDisabled	bool	-	-	-	Tells when the button should present a disabled state
onClick	func	✅	-	-	What the button will trigger when clicked
size	oneOf	-	big, small	big	-
tone	oneOf	-	urgent, primary	primary	The component may have a theme only if isToggleButton is true
as	string or element	-	-	-	You may pass in a string like "a" to have the button render as an anchor tag instead. Or you could pass in a React Component, like a Link.

The component further forwards all valid HTML attributes to the underlying button component.

Main Functions and use cases are:

• Primary action example: Save changes

• Affirming affects example: Submit a form

• Attracting attention example: Add a discount rule