VizColorLegendConfig

Playground

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

Documented example VizColorLegendConfig : append x to the first field, {"encodings":{"color":{"field":"categoryx","type":"nominal","range":["#2563eb","#b45309"]}}}.

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

Code

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

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

const value = {
  "encodings": {
    "color": {
      "field": "category",
      "type": "nominal",
      "range": [
        "#2563eb",
        "#b45309"
      ]
    }
  }
};

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

Props, slots and events

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

Slots

none

Events

change

States

bound, editing, invalid, disabled

Accessibility

Role

textbox

How it gets its name

label on input[name="color.field"]

Keyboard

Obligations in the contract

• Native labelled controls expose focus and invalid-edit feedback; successful edits emit a typed viz.render input fragment.

Color legend: controls the public Cartesian viz.render fragment, not the legacy HTML placeholder's unimplemented styling fields. The consumer supplies rows and calls the renderer. Opacity uses six bounded presets; fields/colors/scale/chart type preserve sibling input bindings. No consumer action is executed by this component.

Tokens

The token roles this component reads.

• input.background
• input.border
• input.text
• input.focus
• field.message

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.

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

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.VizColorLegendConfig sha256:dfd3ef0bc80b…
• Documented example: @oods/component-contracts@0.10.1 sharedScenarios VizColorLegendConfig sha256:c983799015a9…
• Catalog entry (catalog_list): generated/0.10.1/system/catalog.json VizColorLegendConfig sha256:e3d6df687277…
• React readiness: @oods/components-react@0.10.1 readiness VizColorLegendConfig sha256:262d7bd9fd77…
• Vue readiness: @oods/components-vue@0.10.1 readiness VizColorLegendConfig sha256:dade126590b1…
• Prop types: generated/0.10.1/components/prop-types.json VizColorLegendConfig sha256:3200947d11d0…