@aurodesignsystem/auro-badge
Advanced tools
<auro-badge> is a HTML custom element for the use of drawing attention to additional interface information.
For the most up to date information on UI development browser support
$ npm i @aurodesignsystem/auro-badge
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-badge> component.
import "@aurodesignsystem/auro-badge";
Reference component in HTML
<auro-badge>Hello World</auro-badge>
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-badge@latest/dist/auro-badge__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.
Default auro-badge
<auro-badge>Hello World</auro-badge>
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:8000
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-badge.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.
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.
FAQs
Auro custom auro-badge element
The npm package @aurodesignsystem/auro-badge receives a total of 380 weekly downloads. As such, @aurodesignsystem/auro-badge popularity was classified as not popular.
We found that @aurodesignsystem/auro-badge 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
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.