Components / content
InlineLabel
Displays a compact record label within a line of text.
Generated from @oods/foundry 0.10.1
- Categories
- content
- Contexts
- inline
- Readiness
proven-in-generated-apps
Playground
This component's contract doesn't list typed props, so the playground shows its documented example.
Documented example inline-label-truncation : mount, label is truncated with the HTML suffix; noninteractive span.
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 { InlineLabel } from '@oods/components-react';
import '@oods/component-styles/css';
export function Example() {
return (
<InlineLabel
label="Long inline label"
maxLength={8}
/>
);
}Props, slots and events
Contract version 1.1.0. Types are from the React declarations in @oods/components-react.
| Prop | Type | Required | Documented example |
|---|---|---|---|
label | string | undefined | no | Long inline label |
text | string | undefined | no | |
value | string | undefined | no | |
max | string | number | undefined | no | 8 |
Slots
default
Events
none
States
populated, empty
Accessibility
- Role
none- How it gets its name
noneon:root
Keyboard
The contract lists no keyboard behaviour.
Obligations in the contract
- label is truncated with the HTML suffix
- noninteractive span
Mirrors renderInlineLabel with label/text/value precedence, numeric maxLength truncation and authored children replacing the label. The generic field binds label so its datum retains truncation semantics instead of becoming authored children.
Tokens
The token roles this component reads.
text.primary
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.
| Evidence | React | Vue |
|---|---|---|
| state | implemented-evidence-complete | implemented-evidence-complete |
| versioned contract | passed | passed |
| target implementation | passed | passed |
| package export | passed | passed |
| public declaration | passed | passed |
| dependency closure | passed | passed |
| framework scenario | passed | passed |
| accessibility | verified | verified |
| interaction | not-applicable | not-applicable |
| visual themes | verified | verified |
InlineLabel 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": "<YourInlineLabel>",
"oodsTraits": [
"Labelled"
],
"substitution": {
"component": "InlineLabel",
"react": {
"package": "<your-package>/react",
"version": "<exact version>",
"export": "<YourInlineLabel>"
},
"vue": {
"package": "<your-package>/vue",
"version": "<exact version>",
"export": "<YourInlineLabel>"
}
}
} 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.InlineLabelsha256:b45260beb2ba… - Documented example:
@oods/component-contracts@0.10.1 sharedScenarios inline-label-truncationsha256:3b7b5bb4f6bc… - Catalog entry (catalog_list):
generated/0.10.1/system/catalog.json InlineLabelsha256:5d7fb49f7934… - React readiness:
@oods/components-react@0.10.1 readiness InlineLabelsha256:9eef7c2c6a66… - Vue readiness:
@oods/components-vue@0.10.1 readiness InlineLabelsha256:c8d89bfdfb15… - Prop types:
generated/0.10.1/components/prop-types.json InlineLabelsha256:4b3804a297c2…