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

# PreferenceSummaryBadge

Shows a compact preference summary.

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 `preference-summary-badge-namespace-and-version` : mount, namespace is the visible label and version the status in the preference variant.

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

The real PreferenceSummaryBadge, live

React

notifications

Vue

notifications

## Code

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

**React**

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

export function Example() {
  return (
    <PreferenceSummaryBadge
      namespace="notifications"
      version="v3"
    />
  );
}
```

## 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 | |
| `text` | `string \| undefined` | no | |
| `namespace` | `string \| undefined` | no | `notifications` |
| `value` | `string \| undefined` | no | |
| `status` | `string \| undefined` | no | |
| `state` | `string \| undefined` | no | |
| `version` | `string \| undefined` | no | `v3` |
| `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 renderPreferenceSummaryBadge over renderBadgePrimitive with default variant preference and default label Preferences: the label reads label/text/namespace/value in that order, the status reads status/state/version, 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. versionField lowers to version; namespacesField is consumed and left unbound because the renderer reads a scalar namespace alias while the field is the preference_namespaces array.

## 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 |

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

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

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.PreferenceSummaryBadge` `sha256:091af3833e9d…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios preference-summary-badge-namespace-and-version` `sha256:5a36a7e0bc96…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json PreferenceSummaryBadge` `sha256:2dc019c1a21b…`
- **React readiness**: `@oods/components-react@0.10.1 readiness PreferenceSummaryBadge` `sha256:78a7c24b9c93…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness PreferenceSummaryBadge` `sha256:b728607474c6…`
- **Prop types**: `generated/0.10.1/components/prop-types.json PreferenceSummaryBadge` `sha256:827099d93c85…`