Button

<auro-button> is a HTML custom element for the purpose being a clickable element to trigger a specific action.

Responsive support

<auro-button> is responsive by default. The button will assume 100% of the width of its container for views less than auro_breakpoint--sm.

Beyond that breakpoint <auro-button> will assume the width of the content or a min-width of 8.75rem, which ever is greater.

If the desired appearance of the <auro-button> is to be placed in the reverse direction of natural content, then the attributes of responsive and reverse are needed on the <auro-button> element.

Multi button support

When the UI requires the use of multiple buttons within the same space, with the use of the Auro Web Core Style Sheets, and the auro_containedButtons.

UI development browser support

For the most up to date information on UI development browser support

Install

$ npm i @aurodesignsystem/auro-button

Design Token CSS Custom Property dependency

The use of any Auro custom element has a dependency on the Auro Design Tokens.

Define dependency in project component

Defining the component dependency within each component that is using the <auro-button> component.

import "@aurodesignsystem/auro-button";

Reference component in HTML

<auro-button>Primary</auro-button>
<auro-button variant="secondary">Secondary</auro-button>
<auro-button variant="tertiary">Tertiary</auro-button>
<auro-button variant="ghost">Ghost</auro-button>

Use CDN

In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.

<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-button@latest/+esm"></script>

auro-button use cases

The auro-button element should be used in situations where users may:

submit a form
begin a new task
trigger a new UI element to appear to the page
specify a new or next step in a process

API Code Examples

Default auro-button

<auro-button>Primary</auro-button>
<auro-button variant="secondary">Secondary</auro-button>
<auro-button variant="tertiary">Tertiary</auro-button>
<auro-button variant="ghost">Ghost</auro-button>

Development

In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.

Please be sure to review the contribution guidelines for this project. Please make sure to pay special attention to the conventional commits section of the document.

Start development environment

Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the dev server.

$ npm run dev

Open localhost:8000

Testing

Automated tests are required for every Auro component. See .\test\auro-button.test.js for the tests for this component. Run npm run test to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See the testing documentation for more details.

Détail du package

@aurodesignsystem/auro-button

readme