@aurodesignsystem/auro-alert
Advanced tools
<auro-alert> is a HTML custom element for the purpose of illustrating alert messages to Alaska customers.
For the most up to date information on UI development browser support
$ npm i @aurodesignsystem/auro-alert
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 answer.
The use of any Auro custom element has a dependency on the Auro Design Tokens.
CSS custom properties are not supported 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.
Defining the component dependency within each component that is using the <auro-alert> component.
import "@aurodesignsystem/auro-alert";
Reference component in HTML
Default auro-alert
<auro-alert type="error">Departing flight AS 1066 cannot accommodate any ... </auro-alert>
<auro-alert type="warning">Departing flight AS 1066 cannot accommodate any ... </auro-alert>
<auro-alert type="information">Departing flight AS 1066 cannot accommodate any ... </auro-alert>
<auro-alert type="success">Updates to your flight AS 1066 have been saved. </auro-alert>
auro-alert with nested content/components
<auro-alert type="information">
<p>For your child's safety, unaccompanied minors aged 8-17 can only fly on Alaska Airlines flights departing between 5:00 AM and 9:00 PM. <auro-hyperlink href="/children-travel">Rules for children traveling alone.</auro-hyperlink></p>
<p>We searched for all Seattle Area, WA airports. Be sure to note which airport is being used.</p>
<p>We searched for all Bay Area, CA airports. Be sure to note which airport is being used.</p>
</auro-alert>
In cases where the project is not able to process JS assets, there are pre-processed assets available for use.
Include the following example HTML code in the <head> element of your page.
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@alaskaairux/design-tokens@latest/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@alaskaairux/webcorestylesheets@latest/dist/bundled/essentials.css" />
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-alert@latest/dist/auro-alert__bundled.js" type="module"></script>
NOTE: Be sure to replace @latest in the URL with the version of the asset you want. @latest is NOT aware of any MAJOR releases, use at your own risk.
Both Unpkg and JSDelivr are free open source options that you can use. These are 3rd party resources and Auro is not responsible for their uptime. Use at your own risk. These bundle resources are included with the npm package, you are free to use any CDN resource that fits your needs.
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.
Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open two different shell sessions. One is for the npm tasks, the second is to run the server.
// shell terminal one
$ npm run dev
// shell terminal two
$ npm run serve
Open localhost:8000
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.
Automated tests are required for every Auro component. See .\test\auro-alert.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 for more details.
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.
To deploy a demo version of the component for review, run npm run demo:build to create a ./build directory that can be pushed to any static server.
Built from WC-Generator v3.6.2
FAQs
auro-alert HTML custom element
The npm package @aurodesignsystem/auro-alert receives a total of 3,282 weekly downloads. As such, @aurodesignsystem/auro-alert popularity was classified as popular.
We found that @aurodesignsystem/auro-alert demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."