Badges are visual indicators for numeric values such as tallies and other quantities.
They are not used for anything other than integers. For statuses, use Lozenges. To call out tags or other high-visibility attributes, use Labels. Badges are used before or, more commonly, after the name or label of the thing they quantify. Use badges unambiguously – they should always be used singly, after a single item name. Use tooltips to enhance user understanding – to indicate units, for example. Badges are for counts, so should only contain numbers.
npm install ak-badge
The ak-badge package exports the AkBadge Skate component.
Import the component in your JS resource:
import AkBadge from 'ak-badge';
Now we can use the defined tag in our HTML markup, e.g.:
<html>
<head>
<script src="bundle.js"></script>
</head>
<body>
<!-- ... -->
<ak-badge value="256" appearance="added"></ak-badge>
</body>
import AkBadge from 'ak-badge';
import reactify from 'skatejs-react-integration';
const ReactComponent = reactify(AkBadge, {});
ReactDOM.render(<ReactComponent />, container);
Properties
akBadge.value : numberakBadge.max : numberakBadge.appearance : stringCreate instances of the component programmatically, or using markup.
JS Example
import AkBadge from 'ak-badge';
const component = new AkBadge();
akBadge.value : numberThe value displayed within the badge.
Kind: instance property of AkBadge
Default: 0
akBadge.max : numberThe max value to display. If value is 100, and max is 50, "50+" will be displayed
Kind: instance property of AkBadge
Default: 99
akBadge.appearance : stringAffects the visual style of the badge. Allowed values are: 'default', 'primary', 'important', 'added', 'removed'.
Kind: instance property of AkBadge
Default: "default"
FAQs
A React component that indicates values
The npm package ak-badge receives a total of 5 weekly downloads. As such, ak-badge popularity was classified as not popular.
We found that ak-badge demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.