FormLabelGroup

Playground

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

Documented example form-label-group-association : mount, for targets the authored input id; hint is visible.

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

export function Example() {
  return (
    <FormLabelGroup
      label="Product name"
      placeholder="Name shown to customers"
      htmlFor="product-name"
    />
  );
}

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

• for targets the authored input id
• hint is visible

Mirrors renderFormLabelGroup: a label with htmlFor/for/inputId association, label/text/title precedence and placeholder/hint/description hint precedence. Children sit between the label and hint. labelField, descriptionField and placeholderField bind consumed runtime keys. maxLabelLengthParameter, maxDescriptionLengthParameter and requireDescriptionParameter are consumed without runtime values; this label alone does not implement an editor.

Tokens

The token roles this component reads.

• text.primary
• text.secondary

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.

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

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.FormLabelGroup sha256:5b582caaa95d…
• Documented example: @oods/component-contracts@0.10.1 sharedScenarios form-label-group-association sha256:9b0ec6378f5f…
• Catalog entry (catalog_list): generated/0.10.1/system/catalog.json FormLabelGroup sha256:dc84f2b343d3…
• React readiness: @oods/components-react@0.10.1 readiness FormLabelGroup sha256:1cf1938781c3…
• Vue readiness: @oods/components-vue@0.10.1 readiness FormLabelGroup sha256:5293b4d33d70…
• Prop types: generated/0.10.1/components/prop-types.json FormLabelGroup sha256:7b925fc735ee…