Button

OverviewStyleGuidelinesCodeAccessibilityDemos
  1. Installation
  2. Usage
  1. Installation
  2. Usage

Installation

We recommend import maps when building pages with RHDS. Learn more about how to install on our getting started docs.

Red Hat CDN 
<script type="importmap">
{
  "imports": {
    "@rhds/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@rhds/elements@2.1.2/elements/",
  }
}
</script>
Copy to Clipboard Wrap lines NPM 
npm install @rhds/elements
Copy to Clipboard Wrap lines JSPM 
<script type="importmap">
Could not generate import map using JSPM: Cannot read properties of undefined (reading '@rhds/elements')
</script>
Copy to Clipboard Wrap lines

Add it to your page with this import statement

<script type="module">
  import '@rhds/elements/rh-button/rh-button.js';
</script>
Copy to Clipboard Wrap lines

Usage

<rh-button>Primary</rh-button>

<script type="module">
  import '@rhds/elements/rh-button/rh-button.js';
</script>
Copy to Clipboard Wrap lines

rh-button

A button is clickable text or an icon that triggers an action on the page or in the background. Depending on the action, content, and hierarchy, a button can be used on its own or grouped with other buttons.

Slots 2
Slot Name Description
icon

Contains the button's icon or state indicator, e.g. a spinner.

Contains button text
Attributes 9
Attribute DOM Property Description Type Default
disabled disabled

Disables the button

 
boolean
 
false
type type

button type

 
'button' | 'submit' | 'reset' | undefined
 
unknown
label label

Accessible name for the button, use when the button does not have slotted text

 
string | undefined
 
unknown
value value

Form value for the button

 
string | undefined
 
unknown
name name

Form name for the button

 
string | undefined
 
unknown
icon icon

Shorthand for the icon slot, the value is icon name

 
IconNameFor<IconSetName> | undefined
 
unknown
icon-set iconSet

Icon set for the icon property - 'ui' by default

 
IconSetName | undefined
 
unknown
variant variant

Changes the style of the button.

  • Primary: Used for the most important call to action on a page. Try to limit primary buttons to one per page.
  • Secondary: Use secondary buttons for general actions on a page, that don’t require as much emphasis as primary button actions. For example, you can use secondary buttons where there are multiple actions, like in toolbars or data lists.
  • Tertiary: Tertiary buttons are flexible and can be used as needed.
 
| 'primary' | 'secondary' | 'tertiary' | 'close' | 'play'
 
'primary'
danger danger

Use danger buttons for actions a user can take that are potentially destructive or difficult/impossible to undo, like deleting or removing user data.

 
boolean
 
false
Methods 1
Method Name Description
focus()
Events 0
None
CSS Shadow Parts 2
Part Name Description
button

Internal button element
icon

Container for the icon slot
CSS Custom Properties 0
None
Design Tokens 33
Token Copy
--rh-border-radius-default
--rh-border-width-md
--rh-border-width-sm
--rh-color-blue-70
--rh-color-border-strong-on-dark
--rh-color-border-strong-on-light
--rh-color-gray-40
--rh-color-gray-90-rgb
--rh-color-icon-secondary-on-dark
--rh-color-icon-secondary-on-light
--rh-color-interactive-primary-default-on-dark
--rh-color-interactive-primary-default-on-light
--rh-color-interactive-primary-hover-on-dark
--rh-color-interactive-primary-hover-on-light
--rh-color-red-30
--rh-color-red-60
--rh-color-surface-dark
--rh-color-surface-light
--rh-color-text-primary-on-dark
--rh-color-text-primary-on-light
--rh-color-text-secondary-on-dark
--rh-color-text-secondary-on-light
--rh-font-size-body-text-md
--rh-font-weight-body-text-regular
--rh-length-4xl
--rh-length-4xs
--rh-length-lg
--rh-line-height-body-text
--rh-opacity-50
--rh-opacity-80
--rh-size-icon-02
--rh-space-lg
--rh-space-sm
Edit this page on GitHub