Playground

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

Documented example color-swatch-label-and-chip : mount in normal and forced-colors modes, decorative chip with an always-visible Ocean blue label.

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

The real ColorSwatch, live
React
Ocean blue
Vue
Ocean blue

Code

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

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

export function Example() {
  return (
    <ColorSwatch
      color="#2563eb"
      label="Ocean blue"
    />
  );
}

Props, slots and events

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

Props
PropTypeRequiredDocumented example
color string | undefined no #2563eb
value string | undefined no
state string | undefined no
label string | undefined no Ocean blue

Slots

default

Events

none

States

default

Accessibility

Role
none
How it gets its name
none on :root

Keyboard

The contract lists no keyboard behaviour.

Obligations in the contract

  • A visible text label always accompanies the decorative color chip
  • Color is never the sole carrier in high-contrast or forced-colors modes

Mirrors renderColorSwatch color/value/state precedence and data-swatch-color; the visible label falls back to the resolved color.

Tokens

The token roles this component reads.

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

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

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.ColorSwatch sha256:1fc0b9771688…
  • Documented example: @oods/component-contracts@0.10.1 sharedScenarios color-swatch-label-and-chip sha256:ec153edde794…
  • Catalog entry (catalog_list): generated/0.10.1/system/catalog.json ColorSwatch sha256:416abffe5ed9…
  • React readiness: @oods/components-react@0.10.1 readiness ColorSwatch sha256:412fe18f2856…
  • Vue readiness: @oods/components-vue@0.10.1 readiness ColorSwatch sha256:64904e88bc43…
  • Prop types: generated/0.10.1/components/prop-types.json ColorSwatch sha256:b110ec0e8c3e…