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

# AddressSummaryBadge

Shows a compact address label or role.

Generated from @oods/foundry 0.10.1

- Categories

  core

- Contexts

  list

- Readiness

  `react-and-vue`

## Playground

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

Documented example `address-summary-badge-role` : mount, visible Billing address label with data-badge-status billing and the address variant.

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

The real AddressSummaryBadge, live

React

Billing address

Vue

Billing address

## Code

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

**React**

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

export function Example() {
  return (
    <AddressSummaryBadge
      label="Billing address"
      role="billing"
    />
  );
}
```

## 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 |
| - | - | - | - |
| `label` | `string \| undefined` | no | `Billing address` |
| `text` | `string \| undefined` | no | |
| `role` | `string \| undefined` | no | `billing` |
| `value` | `string \| undefined` | no | |
| `status` | `string \| undefined` | no | |
| `state` | `string \| undefined` | no | |
| `variant` | `string \| undefined` | no | |
| `tone` | `ComponentTone \| undefined` | no | |
| `emphasis` | `ComponentEmphasis \| undefined` | no | |

### Slots

default

### Events

none

## States

subtle, solid

## Accessibility

- Role

  `none`

- How it gets its name

  `none` on `:root`

### Keyboard

The contract lists no keyboard behaviour.

### Obligations in the contract

- Inherits Badge inline noninteractive status label semantics
- The resolved label is always visible text

Mirrors renderAddressSummaryBadge over renderBadgePrimitive with default variant address and default label Address: the label reads label/text/role/value in that order, the status reads status/state/role, and both are exposed as data-badge-status and data-badge-variant on the governed Badge substrate; tone and emphasis retain their shared Badge behaviour. The generic field lowers to role (the address role that names the status), so an authored label stays the visible text while the bound role drives data-badge-status; role is the address role, never an ARIA role, on a noninteractive badge.

## Tokens

The token roles this component reads.

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

## Readiness

The evidence recorded for this component, with its label.

`react-and-vue`: catalog_list gives this label when the React and Vue components have complete readiness evidence, but the sweep's generated apps don't use the component in both.

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 |

AddressSummaryBadge 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": "<YourAddressSummaryBadge>",
  "oodsTraits": [
    "Addressable"
  ],
  "substitution": {
    "component": "AddressSummaryBadge",
    "react": {
      "package": "<your-package>/react",
      "version": "<exact version>",
      "export": "<YourAddressSummaryBadge>"
    },
    "vue": {
      "package": "<your-package>/vue",
      "version": "<exact version>",
      "export": "<YourAddressSummaryBadge>"
    }
  }
}
```

## 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/address-summary-badge/manifest.json).

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.AddressSummaryBadge` `sha256:355d1c114418…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios address-summary-badge-role` `sha256:9f67e424bf45…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json AddressSummaryBadge` `sha256:ce787ed85da4…`
- **React readiness**: `@oods/components-react@0.10.1 readiness AddressSummaryBadge` `sha256:fe81ed615c84…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness AddressSummaryBadge` `sha256:11ba552d51bf…`
- **Prop types**: `generated/0.10.1/components/prop-types.json AddressSummaryBadge` `sha256:a72bbdd2792e…`