UNPKG

@aurodesignsystem/auro-header

Version:
46 lines (35 loc) 1.86 kB
<!-- THIS PAGE'S CONTENT SHOULD BE KEPT MINIMAL. ONLY ADD EXAMPLES THAT ARE TRULY NECESSARY FOR THE INDEX PAGE — THE BASIC EXAMPLE IS USUALLY ENOUGH. ALL OTHER EXAMPLES SHOULD GO IN THE API DOCUMENTATION. --> # Header <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) --> <!-- The below content is automatically added from ./../docs/partials/description.md --> The `<auro-header>` element is for rendering page or content headers without having to deal with font styling. Simply choose the level of the header you want and the style type. The `<auro-header>` element is able to take any combination of options for heading levels and display options. See [Auro's header usage guidelines](https://auro.alaskaair.com/typography/usage) for additional examples sans web component dependency. <!-- AURO-GENERATED-CONTENT:END --> ## Use Cases <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/useCases.md) --> <!-- The below content is automatically added from ./../docs/partials/useCases.md --> The `<auro-header>` element should be used in situations where users may: * page header * content / paragraph header <!-- AURO-GENERATED-CONTENT:END --> ## Example(s) ### Basic <div class="exampleWrapper"> <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic.html) --> <!-- The below content is automatically added from ./../apiExamples/basic.html --> <auro-header>Hello World!</auro-header> <!-- AURO-GENERATED-CONTENT:END --> </div> <auro-accordion alignRight> <span slot="trigger">See code</span> <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) --> <!-- The below code snippet is automatically added from ./../apiExamples/basic.html --> ```html <auro-header>Hello World!</auro-header> ``` <!-- AURO-GENERATED-CONTENT:END --> </auro-accordion>