OwnershipSummary

Playground

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

Documented example ownership-summary-terms : mount, a real h2 names the description list; owner label or honest unavailability, type and role remain associated terms.

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

export function Example() {
  return (
    <OwnershipSummary
      ownerId="user-7"
      ownerType="person"
      role="administrator"
    />
  );
}

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, fallback, empty

Accessibility

Role

none

How it gets its name

heading on h1,h2,h3,h4,h5,h6

Keyboard

The contract lists no keyboard behaviour.

Obligations in the contract

• a real h2 names the description list
• owner label, type and role remain associated terms

Mirrors renderOwnershipSummary over renderSummarySection: title/label/heading/name (default Ownership Summary); Owner reads an explicitly resolved ownerLabel for ownerId/owner_id, otherwise reports Owner unavailable or Owner reference not resolved. Generated detail screens retain raw reference values in a collapsed Reference details disclosure. Owner Type ownerType/owner_type, Role role/ownershipRole; summary/text/description is a fallback when no term resolves. Children replace the body but retain the h2 heading. ownerIdField, ownerTypeField and roleField lower to their runtime keys. transferredAtField and allowTransferParameter are consumed unbound; no transfer term or action is implemented. role is displayed data, never an ARIA role.

Tokens

The token roles this component reads.

• summary.background
• summary.border
• summary.text
• summary.label

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.

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

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.OwnershipSummary sha256:27c2a7ba8898…
• Documented example: @oods/component-contracts@0.10.1 sharedScenarios ownership-summary-terms sha256:1a985b25835f…
• Catalog entry (catalog_list): generated/0.10.1/system/catalog.json OwnershipSummary sha256:56108a7ab293…
• React readiness: @oods/components-react@0.10.1 readiness OwnershipSummary sha256:9a1501ba245f…
• Vue readiness: @oods/components-vue@0.10.1 readiness OwnershipSummary sha256:861eb723e376…
• Prop types: generated/0.10.1/components/prop-types.json OwnershipSummary sha256:ad8aa9f92ff0…