LabelCell

Playground

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

Documented example label-cell-truncation-and-description : mount, primary and description are truncated with the HTML suffix; no editor is implied.

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

export function Example() {
  return (
    <LabelCell
      label="Long primary label"
      description="Long supporting text"
      maxLength={8}
    />
  );
}

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

none

How it gets its name

none on :root

Keyboard

The contract lists no keyboard behaviour.

Obligations in the contract

• primary and description are truncated with the HTML suffix
• no editor is implied

Mirrors renderLabelCell: label/text/value precedence, description/subtitle/sublabel/supporting precedence, truncate defaults the limit to 40, and maxLength accepts a number or numeric string. Truncation uses the HTML three-dot suffix. Authored children replace the entire body. field binds label and descriptionField binds description; maxLengthParameter is consumed without a runtime value.

Tokens

The token roles this component reads.

• text.primary
• text.secondary

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.

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

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.LabelCell sha256:86b901dd9859…
• Documented example: @oods/component-contracts@0.10.1 sharedScenarios label-cell-truncation-and-description sha256:8e825208a44f…
• Catalog entry (catalog_list): generated/0.10.1/system/catalog.json LabelCell sha256:0301ac668155…
• React readiness: @oods/components-react@0.10.1 readiness LabelCell sha256:40653ded157a…
• Vue readiness: @oods/components-vue@0.10.1 readiness LabelCell sha256:f2f59605629e…
• Prop types: generated/0.10.1/components/prop-types.json LabelCell sha256:6e7c74950abc…