# @visual-framework/vf-badge
> vf-badge component
Latest version **3.0.5** (published 2025-04-01) · Apache 2.0 license · 0 weekly downloads
## Install
```sh
npm install @visual-framework/vf-badge
pnpm add @visual-framework/vf-badge
yarn add @visual-framework/vf-badge
bun add @visual-framework/vf-badge
```
## Health
**Score 25/100 (F)** — status: maintenance-mode.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: stale; low maintenance score.
## Facts
| | |
|---|---|
| Version | 3.0.5 |
| Published | 2025-04-01 |
| First published | 2018-12-12 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 72.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | VF |
| Maintainers | sandykadam, ebiwebdev, khawkins98, pacope92, bhushan-ebi |
| Keywords | fractal, component |
## Links
- npm: https://www.npmjs.com/package/@visual-framework/vf-badge
- Homepage: https://stable.visual-framework.dev/
- Issues: https://github.com/visual-framework/vf-core/issues/new
- npm.io page: https://npm.io/package/@visual-framework/vf-badge
## Dependencies (3)
- [@visual-framework/vf-box](https://npm.io/package/@visual-framework/vf-box.md) ^2.4.0
- [@visual-framework/vf-stack](https://npm.io/package/@visual-framework/vf-stack.md) ^3.0.1
- [@visual-framework/vf-u-fullbleed](https://npm.io/package/@visual-framework/vf-u-fullbleed.md) ^1.2.3
## Recent versions
- 3.0.5 (latest) — 2025-04-01
- 3.0.4 — 2025-02-25
- 3.0.3 — 2024-08-14
- 3.0.2 — 2024-05-17
- 3.0.1 — 2024-05-01
- 3.0.0 — 2024-05-01
- 3.0.0-alpha.2 — 2024-05-01
- 3.0.0-alpha.1 — 2023-05-10
- 3.0.0-alpha.0 — 2023-03-21
- 2.0.1 — 2021-05-31
- 2.0.0 — 2021-05-31
- 1.3.0 — 2021-05-19
- 1.2.3 — 2021-02-25
- 1.2.2 — 2020-10-27
- 1.2.1 — 2020-09-03
- … 29 more at https://npm.io/package/@visual-framework/vf-badge/versions
## README
# Badge component
[](https://badge.fury.io/js/%40visual-framework%2Fvf-badge)
## About
The `vf-badge` component is used to denote if a page, section, or link has a production state of `alpha`, `beta` or other information.
## Usage
The `vf-badge` accepts a single text item of content.
| content type | variable | description |
| ------------ | -------- | ----------- |
| text | `text` | |
### Links
The `vf-badge` component can also be a link using `badge title`.
### Nunjucks and yml options
#### Nunjucks and YML variables available
| variable | options | default |
| -------------- | --------- | ------- |
| text | | |
| badge_href | | null |
| theme | 'primary' | |
| style | 'outline' | |
| override_class | | |
| id | | |
### Angular
As of version 3.0.0-alpha.0 vf-badge has experimental Angular support.
This package was generated with Angular version 15.2.0 and has been tested on application with Angular version 15.2.0.
1. install `yarn add @visual-framework/vf-badge`
2. import in your app.module
```
import { VfBadgeAngularModule } from '@visual-framework/vf-badge/vf-badge.angular';
@NgModule({
imports: [VfBadgeAngularModule, YourOtherModules],
...
})
```
3. can be used as
```
```
4. add to your styles.scss
```
@import '../node_modules/@visual-framework/vf-sass-config/index.scss';
@import "../node_modules/@visual-framework/vf-badge/vf-badge.scss";
```
you should also install [vf-sass-starter](https://stable.visual-framework.dev/components/vf-sass-starter) for the styles
Usage:
```
```
### React
As of version 3.0.0-alpha.1 vf-badge has experimental React support which has been tested on react version 18.2.0
1. install `yarn add @visual-framework/vf-badge`
2. import in the JS file wheree you want to include this component
```
import VfBadge from '@visual-framework/vf-badge/vf-badge.react';
Make sure you have the jsx support enabled with babel. Alternatively, you can also copy the vf-badge.react.js file from below to your react project and import as per the location.
```
3. can be used as
```
```
4. add beloow to your CSS file
```
@import '~@visual-framework/vf-sass-config/index.scss';
@import '~@visual-framework/vf-badge/vf-badge.css';
```
you should also install and import [vf-sass-starter](https://stable.visual-framework.dev/components/vf-sass-starter) for the styles
Usage:
```
```
## Install
This repository is distributed with [npm](https://www.npmjs.com/). After [installing npm](https://www.npmjs.com/get-npm) and [yarn](https://classic.yarnpkg.com/en/docs/install), you can install `vf-profile` with this command.
```
$ yarn add --dev @visual-framework/vf-badge
```
### Sass/CSS
The style files included are written in [Sass](https://sass-lang.com/). If you're using a VF-core project, you can import it like this:
```
@import "@visual-framework/vf-badge/index.scss";
```
Make sure you import Sass requirements along with the modules. You can use a [project boilerplate](https://stable.visual-framework.dev/building/) or the [`vf-sass-starter`](https://stable.visual-framework.dev/components/vf-sass-starter/)
## Help
- [Read the Visual Framework troubleshooting](https://stable.visual-framework.dev/troubleshooting/)
- [Open a ticket](https://github.com/visual-framework/vf-core/issues)
- [Chat on Slack](https://join.slack.com/t/visual-framework/shared_invite/enQtNDAxNzY0NDg4NTY0LWFhMjEwNGY3ZTk3NWYxNWVjOWQ1ZWE4YjViZmY1YjBkMDQxMTNlNjQ0N2ZiMTQ1ZTZiMGM4NjU5Y2E0MjM3ZGQ)
---
_Source: https://npm.io/package/@visual-framework/vf-badge · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._