@aurodesignsystem-dev/auro-lockup
v0.0.0-pr75.1
Published
auro-lockup HTML custom element
Downloads
423
Readme
Lockup
The auro-lockup HTML custom element is a standardized use case element for authorized Alaska Airlines extended experiences.
UI development browser support
For the most up to date information on UI development browser support
Install
$ npm i @aurodesignsystem/auro-lockupDesign Token CSS Custom Property dependency
The use of any Auro custom element has a dependency on the Auro Design Tokens.
Define dependency in project component
Defining the component dependency within each component that is using the <auro-lockup> component.
import "@aurodesignsystem/auro-lockup";Reference component in HTML
<auro-lockup>
<span slot="title">Place title text here</span>
<span slot="subtitle">Place subtitle text here</span>
</auro-lockup>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-lockup@latest/+esm"></script>auro-lockup use cases
The auro-lockup use cases include:
- Product lines
- Partner services
- Auxiliary sites
API Code Examples
Default auro-lockup
<auro-lockup>
<span slot="title">Place title text here</span>
<span slot="subtitle">Place subtitle text here</span>
</auro-lockup>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 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.
$ npm run devOpen localhost:8000
Testing
Automated tests are required for every Auro component. See .\test\auro-lockup.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.
