Playground

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

Documented example classification-badge-category : mount, category is visible; mode is the status metadata; noninteractive badge.

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

The real ClassificationBadge, live
React
Electronics
Vue
Electronics

Code

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

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

export function Example() {
  return (
    <ClassificationBadge
      category="Electronics"
      mode="strict"
    />
  );
}

Props, slots and events

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

Props
PropTypeRequiredDocumented example
label string | undefined no
text string | undefined no
category string | undefined no Electronics
value string | undefined no
status string | undefined no
state string | undefined no
mode string | undefined no strict
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

  • category is visible
  • mode is the status metadata
  • noninteractive badge

Mirrors renderClassificationBadge over Badge: label/text/category/value precedence, status/state/mode precedence and classification variant. primaryCategoryField binds category; tagPreviewField is consumed unbound because the HTML badge reads no tag preview. Noninteractive.

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
EvidenceReactVue
stateimplemented-evidence-completeimplemented-evidence-complete
versioned contractpassedpassed
target implementationpassedpassed
package exportpassedpassed
public declarationpassedpassed
dependency closurepassedpassed
framework scenariopassedpassed
accessibilityverifiedverified
interactionnot-applicablenot-applicable
visual themesverifiedverified

ClassificationBadge 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": "<YourClassificationBadge>",
  "oodsTraits": [
    "Classifiable"
  ],
  "substitution": {
    "component": "ClassificationBadge",
    "react": {
      "package": "<your-package>/react",
      "version": "<exact version>",
      "export": "<YourClassificationBadge>"
    },
    "vue": {
      "package": "<your-package>/vue",
      "version": "<exact version>",
      "export": "<YourClassificationBadge>"
    }
  }
}

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.

  • Contract: @oods/component-contracts@0.10.1 componentContracts.ClassificationBadge sha256:29650ea581d0…
  • Documented example: @oods/component-contracts@0.10.1 sharedScenarios classification-badge-category sha256:e9b793b50851…
  • Catalog entry (catalog_list): generated/0.10.1/system/catalog.json ClassificationBadge sha256:e4ad2949adc4…
  • React readiness: @oods/components-react@0.10.1 readiness ClassificationBadge sha256:5f4a14aa7e21…
  • Vue readiness: @oods/components-vue@0.10.1 readiness ClassificationBadge sha256:a29b36304500…
  • Prop types: generated/0.10.1/components/prop-types.json ClassificationBadge sha256:4b5e8a27e43b…