[Components](https://oods-foundry.com/components) / financial

# PriceBadge

Displays a compact formatted price.

Generated from @oods/foundry 0.10.1

- Categories

  financial

- Contexts

  card, list

- Readiness

  `proven-in-generated-apps`

## Playground

This component's contract doesn't list typed props, so the playground shows its documented example.

Documented example `price-badge-currency` : mount, USD 25 is visible as a price badge.

The render follows the page's theme switch: light, dark or high contrast. Both frameworks render the same example.

The real PriceBadge, live

React

$25.00

Vue

$25.00

## Code

The documented example. HTML is the markup the React component renders for it, which @oods/component-styles styles.

**React**

```
import { PriceBadge } from '@oods/components-react';
import '@oods/component-styles/css';

export function Example() {
  return (
    <PriceBadge
      amountCents={2500}
      currency="usd"
    />
  );
}
```

## Props, slots and events

Contract version 1.1.0. Types are from the React declarations in @oods/components-react.

Props

| Prop | Type | Required | Documented example |
| - | - | - | - |
| `amountCents` | `number \| undefined` | no | `2500` |
| `unitAmountCents` | `number \| undefined` | no | |
| `amount` | `number \| undefined` | no | |
| `unitAmount` | `number \| undefined` | no | |
| `currency` | `string \| undefined` | no | `usd` |
| `currencyCode` | `string \| undefined` | no | |
| `label` | `ReactNode` | no | |
| `value` | `string \| number \| undefined` | no | |
| `emphasis` | `ComponentEmphasis \| undefined` | no | |
| `minorUnits` | `number \| undefined` | no | |

### Slots

default

### Events

none

## States

priced, missing-price

## Accessibility

- Role

  `none`

- How it gets its name

  `none` on `:root`

### Keyboard

The contract lists no keyboard behaviour.

### Obligations in the contract

- Formatted amount and currency remain visible text

Currency is formatted content; the emitted badge variant remains price.

## Tokens

The token roles this component reads.

- `badge.background`
- `badge.text`

## Readiness

The evidence recorded for this component, with its label.

`proven-in-generated-apps`: catalog_list gives this label when generated React and Vue apps in the runtime sweep that ships with this version both use the component. That sweep was measured on the published 0.4.1, not on this version.

Readiness evidence

| Evidence | React | Vue |
| - | - | - |
| state | implemented-evidence-complete | implemented-evidence-complete |
| versioned contract | passed | passed |
| target implementation | passed | passed |
| package export | passed | passed |
| public declaration | passed | passed |
| dependency closure | passed | passed |
| framework scenario | passed | passed |
| accessibility | verified | verified |
| interaction | not-applicable | not-applicable |
| visual themes | verified | verified |

PriceBadge presents content and owns no focusable control or action; authored child actions remain the consumer's responsibility.

## Use your own

You can replace this component with your own React or Vue component. Map it, and generated code imports yours at the exact version you name. A contract report, run in a real browser, lists what your component met, what it didn't, and what wasn't checked.

The `component_map` call, with the parts in angle brackets yours to fill:

```
{
  "action": "create",
  "apply": true,
  "externalSystem": "<your design system>",
  "externalComponent": "<YourPriceBadge>",
  "oodsTraits": [
    "Priceable"
  ],
  "substitution": {
    "component": "PriceBadge",
    "react": {
      "package": "<your-package>/react",
      "version": "<exact version>",
      "export": "<YourPriceBadge>"
    },
    "vue": {
      "package": "<your-package>/vue",
      "version": "<exact version>",
      "export": "<YourPriceBadge>"
    }
  }
}
```

## How this page was made

Generated at build from the published data, each source with the hash of what was read. [The page's manifest](https://oods-foundry.com/components/price-badge/manifest.json).

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.PriceBadge` `sha256:63d71ea8ba01…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios price-badge-currency` `sha256:0272f7fdd357…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json PriceBadge` `sha256:987a2c700318…`
- **React readiness**: `@oods/components-react@0.10.1 readiness PriceBadge` `sha256:9b582f84ec41…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness PriceBadge` `sha256:1511c5c3df7e…`
- **Prop types**: `generated/0.10.1/components/prop-types.json PriceBadge` `sha256:a6b98a109b89…`