@aurodesignsystem/auro-icon
Advanced tools
<auro-icon> is a HTML custom element for the purpose of displaying the icons from the Auro Design System.
For the most up to date information on UI development browser support
$ npm i @aurodesignsystem/auro-icon
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-icon> component.
import "@aurodesignsystem/auro-icon";
Reference component in HTML
<auro-icon category="alert" name="error" accent></auro-icon>
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/@aurodesignsystem/design-tokens@latest/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/bundled/essentials.css" />
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-icon@latest/dist/auro-icon__bundled.js" type="module"></script>
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-icon@latest/dist/auro-alaska__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.
The <auro-icon> element should be used in situations where users may:
Primary auro-icon
<auro-icon category="interface" name="chevron-up"></auro-icon>
<auro-icon category="interface" name="chevron-up" onDark></auro-icon>
Emphasis auro-icon
<auro-icon category="interface" name="chevron-up" emphasis></auro-icon>
<auro-icon category="interface" name="chevron-up" emphasis onDark></auro-icon>
Accent auro-icon
<auro-icon category="interface" name="chevron-up" accent></auro-icon>
<auro-icon category="interface" name="chevron-up" accent onDark></auro-icon>
Disabled auro-icon
<auro-icon category="interface" name="chevron-up" disabled></auro-icon>
<auro-icon category="interface" name="chevron-up" disabled onDark></auro-icon>
See auro-alaska.
The auro-icon component has easy access to other than Alaska airline logos.
For full list, see Icons repo.
Example use:
<auro-icon category="logos" name="tail-AS"></auro-icon>
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 a shell session to run the dev server.
// shell terminal one
$ npm run dev
Open localhost:3001
If running separate sessions is preferred, please run the following commands in individual terminal shells.
$ npm run build:watch
$ npm run serve
Automated tests are required for every Auro component. See .\test\auro-icon.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.
FAQs
auro-icon HTML custom element
We found that @aurodesignsystem/auro-icon 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."