@aurodesignsystem/auro-header
v5.0.1
Published
auro-header HTML custom element
Readme
Header
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 for additional examples sans web component dependency.
Use Cases
The <auro-header> element should be used in situations where users may:
- page header
- content / paragraph header
Install
$ npm i @aurodesignsystem/auro-headerDefine Dependency in Project
Defining the dependency within each project that is using the <auro-header> component.
import "@aurodesignsystem/auro-header";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-header@latest/+esm"></script>Basic Example
<auro-header>Hello World!</auro-header>Custom Component Registration for Version Management
There are two key parts to every Auro component: the class and the custom element definition. The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
When you install the component as described on the Install page, the class is imported automatically, and the component is registered globally for you.
However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.
You can do this by importing only the component class and using the register(name) method with a unique name:
// Import the class only
import { AuroHeader } from '@aurodesignsystem/auro-header/class';
// Register with a custom name if desired
AuroHeader.register('custom-header');This will create a new custom element <custom-header> that behaves exactly like <auro-header>, allowing both to coexist on the same page without interfering with each other.
<custom-header>Hello World!</custom-header>