@aurodesignsystem/auro-header

# Header   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 guidlines](https://auro.alaskaair.com/typography/usage) for additional examples sans web component dependency.      ## UI development browser support  For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)  ## Install  [![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-header/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-header/actions/workflows/testPublish.yml) [![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-header?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-header) [![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-header?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0) ![ESM supported](https://img.shields.io/badge/ESM-compatible-FFE900?style=for-the-badge) ```shell $ npm i @aurodesignsystem/auro-header ``` Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this [stack overflow](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.  ### Design Token CSS Custom Property dependency  The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).  ### CSS Custom Property fallbacks  [CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) are [not supported](https://auro.alaskaair.com/support/custom-properties) in older browsers. For this, fallback properties are pre-generated and included with the npm. Any update to the Auro Design Tokens will be immediately reflected with browsers that support CSS custom properties, legacy browsers will require updated components with pre-generated fallback properties.  ### Define dependency in project component  Defining the component dependency within each component that is using the `<auro-header>` component.   ```js import "@aurodesignsystem/auro-header"; ```  **Reference component in HTML**   ```html <auro-header>Hello World!</auro-header> ```  ## Install bundled assets from CDN  In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `auro-header__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported. **WARNING!** When installing into your application environment, DO NOT use `@latest` for the requested version. Risks include unknown MAJOR version releases and instant adoption of any new features and possible bugs without developer knowledge. The `@latest` wildcard should NEVER be used for production customer-facing applications. You have been warned.  ### Bundle example code  ```html <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@4.3.1/dist/tokens/CSSCustomProperties.css" /> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@5.0.8/dist/bundled/essentials.css" /> <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-header@2.2.4/dist/auro-header__bundled.js" type="module"></script> ```  ## auro-header use cases   The `<auro-header>` element should be used in situations where users may: * page header * content / paragraph header  ## API Code Examples ### Default auro-header   ```html <auro-header>Hello World!</auro-header> ```  ## 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](https://auro.alaskaair.com/contributing) 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**. ```shell $ npm run dev ``` Open [localhost:8000](http://localhost:8000/) If running separate sessions is preferred, please run the following commands in individual terminal shells. ```shell $ npm run build:watch $ npm run serve ```  ### API generation  The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run `npm run build:api` to generate the doc and commit to version control.  ### Testing  Automated tests are required for every Auro component. See `.\test\auro-header.test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.  ### Bundled assets  Bundled assets are only generated in the remote and not merged back to this repo. To review and/or test a bundled asset locally, run `$ npm run bundler` to generate assets.