ClassificationEditor

Playground

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

Documented example classification-editor-presentational-controls : mount, labelled native inputs retain their values; mode selection is flexible; submit does not navigate or save.

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 { ClassificationEditor } from '@oods/components-react';
import '@oods/component-styles/css';

const tags = [
  "alpha",
  "beta"
];

export function Example() {
  return (
    <ClassificationEditor
      title="Product classification"
      category="Electronics"
      tags={tags}
      mode="flexible"
    />
  );
}

Props, slots and events

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

Slots

default

Events

none

States

populated, empty

Accessibility

Role

textbox

How it gets its name

label on input[name="category"]

Keyboard

Obligations in the contract

• labelled native inputs retain their values
• mode selection is flexible
• submit does not navigate or save

Mirrors renderClassificationEditor: form header aliases, Category input from category/primaryCategory, serialized Tags input and Mode select from modes or strict/flexible, with mode/classificationMode selection. Children replace the generated controls. modeParameter, tagPolicyParameter and maxTagsParameter are consumed unbound. The generic field binds the visible description subtitle without an invented onChange. Presentational native controls only: submit is prevented; no classification change, persistence or save event is promised.

Tokens

The token roles this component reads.

• form.background
• form.border
• form.text
• form.hint

Readiness

The evidence recorded for this component, with its label.

proven-in-generated-apps: catalog_list gives this label when generated React and Vue apps in the runtime sweep that ships with this version both use the component. That sweep was measured on the published 0.4.1, not on this version.

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

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.ClassificationEditor sha256:74d75e3e0a99…
• Documented example: @oods/component-contracts@0.10.1 sharedScenarios classification-editor-presentational-controls sha256:84450dfe120d…
• Catalog entry (catalog_list): generated/0.10.1/system/catalog.json ClassificationEditor sha256:5bcbc6d24dca…
• React readiness: @oods/components-react@0.10.1 readiness ClassificationEditor sha256:add970fb13c0…
• Vue readiness: @oods/components-vue@0.10.1 readiness ClassificationEditor sha256:080313c91569…
• Prop types: generated/0.10.1/components/prop-types.json ClassificationEditor sha256:85c3b0ccff11…