The <auro-header> component is a simple component for rendering page or content headers without having to deal with font styling. Simply choose the level of the header want and the style type.
The auro-header component is able to take any combination of options for heading levels and display options. See Auro's header usage guidelines for additional examples sans web component dependency.
For the most up to date information on UI development browser support
$ npm i @aurodesignsystem/auro-headerThe use of any Auro custom element has a dependency on the Auro Design Tokens.
Defining the component dependency within each component that is using the <auro-header> component.
import "@aurodesignsystem/auro-header";Reference component in HTML
<auro-header>Hello World!</auro-header>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-header@latest/+esm"></script>The <auro-header> element should be used in situations where users may:
- page header
- content / paragraph header
<auro-header>Hello World!</auro-header>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.
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 devOpen localhost:8000
Automated tests are required for every Auro component. See .\test\auro-header.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.