@aurodesignsystem/auro-header
Version:
auro-header HTML custom element
54 lines • 2.23 kB
TypeScript
/**
* auro-header is a custom element to make using headers with the Auro Design System seamless and easy.
*
* @attr {String} level - Determines heading level for HTML element. Options are `1` - `6`
* @attr {String} display - Determines presentation of header. Options are `display`, `800`, `700`, `600`, `500`, `400`, `300`.
* @attr {String} color - Allows user to pass in CSS custom property or direct hex value to change the color of the header
* @attr {String} margin - Specify the margin(s) to be altered. Options are `top`, `bottom`, or `both`.
* @attr {String} size - Specify size of margin adjustment, either `none`, `25`, `50`, `100`, `150`, `200`, `300`, `400`, `600` or `800`. **DEPRECATED** the `xxxs` - `xxxl` options.
* @attr {String} type - **DEPRECATED** Option, `px`. Legacy option for converting REMs to PX. Use `fixed` feature.
* @attr {Boolean} fixed - Uses px values instead of rem
*/
export class AuroHeader extends LitElement {
static get properties(): {
level: {
type: StringConstructor;
};
display: {
type: StringConstructor;
reflect: boolean;
};
color: {
type: StringConstructor;
};
margin: {
type: StringConstructor;
};
size: {
type: StringConstructor;
};
};
static get styles(): import("lit").CSSResult[];
display: string;
/**
* @private Determines if the spacing is to be applied uniform or individual
* @param {string} size - Accepts string for size definition
* @returns {string} - Returns either selectors or function
*/
private spacingDecision;
/**
* @private If spacing is individual, return will be single selector based on input
* @param {string} size - Accepts string for size definition
* @returns {string} - Returns selector
*/
private spacingApplied;
/**
* @private Creates HTML template for use in render function
* @param {string} level - Accepts string value
* @returns {string} - Returns HTML template
*/
private template;
render(): string;
}
import { LitElement } from "lit";
//# sourceMappingURL=auro-header.d.ts.map