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

# VizEncodingBadge

Labels a field's visual encoding.

Generated from @oods/foundry 0.10.1

- Categories

  viz.encoding

- Contexts

  detail, list

- Readiness

  `react-and-vue`

## Playground

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

Documented example `VizEncodingBadge` : mount the authored fragment or shared-renderer SVG, {"encodings":{"x":{"field":"period","title":"Period","sort":"ascending"}}}.

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

The real VizEncodingBadge, live

React

X: period

Vue

X: period

## Code

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

**React**

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

const value = {
  "encodings": {
    "x": {
      "field": "period",
      "title": "Period",
      "sort": "ascending"
    }
  }
};

export function Example() {
  return (
    <VizEncodingBadge
      value={value}
    />
  );
}
```

## 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 |
| - | - | - | - |
| `title` | `string \| undefined` | no | |
| `value` | `VizIntentFragment \| undefined` | no | `{"encodings":{"x":{"field":"period","title":"Period","sort":"ascending"}}}` |
| `channel` | `VizChannel \| undefined` | no | |

### Slots

none

### Events

none

## States

unbound, bound

## Accessibility

- Role

  `none`

- How it gets its name

  `none` on `[data-oods-component="VizEncodingBadge"]`

### Keyboard

The contract lists no keyboard behaviour.

### Obligations in the contract

- Visible text renders the authored input fragment without implying an executed chart.

Read-only recipe renders the same Cartesian viz.render input fragment. Missing bindings remain disclosed; renderer defaults are not fabricated as authored values.

## Tokens

The token roles this component reads.

- `surface.panel`
- `text.body`

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

VizEncodingBadge displays an authored chart input or rendered static SVG and owns no focusable control or consumer action.

## 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": "<YourVizEncodingBadge>",
  "oodsTraits": [
    "EncodingColor",
    "EncodingPositionX",
    "EncodingPositionY",
    "EncodingSize"
  ],
  "substitution": {
    "component": "VizEncodingBadge",
    "react": {
      "package": "<your-package>/react",
      "version": "<exact version>",
      "export": "<YourVizEncodingBadge>"
    },
    "vue": {
      "package": "<your-package>/vue",
      "version": "<exact version>",
      "export": "<YourVizEncodingBadge>"
    }
  }
}
```

## 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/viz-encoding-badge/manifest.json).

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.VizEncodingBadge` `sha256:f9aa6e01b259…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios VizEncodingBadge` `sha256:854f30c8bf01…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json VizEncodingBadge` `sha256:ffa8fc1622c5…`
- **React readiness**: `@oods/components-react@0.10.1 readiness VizEncodingBadge` `sha256:e91513966f74…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness VizEncodingBadge` `sha256:7cd1e856339d…`
- **Prop types**: `generated/0.10.1/components/prop-types.json VizEncodingBadge` `sha256:654f9f0f3172…`