Icons can be used to represent concepts or provide context to options and/or actions within an experience.
The <auro-icon> web component comes pre-configured with all the available Auro Icons . Simply add the category and name of the icon for quick and easy results.
For the most up to date information on UI development browser support
$ npm i @aurodesignsystem/auro-iconThe use of any Auro custom element has a dependency on the Auro Design Tokens.
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="interface" name="pin-trip"></auro-icon>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-icon@latest/+esm"></script><auro-icon category="interface" name="pin-trip"></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.
$ npm run devOpen localhost:8000
Automated tests are required for every Auro component. See .\test\auro-icon.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.