Playground

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

Documented example owner-badge-principal : mount, owner identity is visible; owner is the badge variant.

The render follows the page's theme switch: light, dark or high contrast. Both frameworks render the same example.

The real OwnerBadge, live
React
user-7
Vue
user-7

Code

The documented example. HTML is the markup the React component renders for it, which @oods/component-styles styles.

import { OwnerBadge } from '@oods/components-react';
import '@oods/component-styles/css';

export function Example() {
  return (
    <OwnerBadge
      owner="user-7"
      ownerType="person"
      status="active"
    />
  );
}

Props, slots and events

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

Props
PropTypeRequiredDocumented example
label string | undefined no
text string | undefined no
owner string | undefined no user-7
ownerType string | undefined no person
value string | undefined no
status string | undefined no active
state string | undefined no
variant string | undefined no
tone ComponentTone | undefined no
emphasis ComponentEmphasis | undefined no

Slots

default

Events

none

States

subtle, solid

Accessibility

Role
none
How it gets its name
none on :root

Keyboard

The contract lists no keyboard behaviour.

Obligations in the contract

  • owner identity is visible
  • owner is the badge variant

Mirrors renderOwnerBadge over renderBadgePrimitive: label/text/owner/ownerType/value precedence, status/state metadata, owner variant and Owner fallback. ownerIdField lowers to the unchanged owner and a display-only label from the declared reference label or honest unavailability; ownerTypeField lowers to ownerType. The badge is noninteractive; no ownership change is implied.

Tokens

The token roles this component reads.

  • badge.background
  • badge.text

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.

Readiness evidence
EvidenceReactVue
stateimplemented-evidence-completeimplemented-evidence-complete
versioned contractpassedpassed
target implementationpassedpassed
package exportpassedpassed
public declarationpassedpassed
dependency closurepassedpassed
framework scenariopassedpassed
accessibilityverifiedverified
interactionnot-applicablenot-applicable
visual themesverifiedverified

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

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.OwnerBadge sha256:259dfdeed571…
  • Documented example: @oods/component-contracts@0.10.1 sharedScenarios owner-badge-principal sha256:8c0ba5cf23a1…
  • Catalog entry (catalog_list): generated/0.10.1/system/catalog.json OwnerBadge sha256:b618492eeab3…
  • React readiness: @oods/components-react@0.10.1 readiness OwnerBadge sha256:6fbe7ccf2f11…
  • Vue readiness: @oods/components-vue@0.10.1 readiness OwnerBadge sha256:a52db185993f…
  • Prop types: generated/0.10.1/components/prop-types.json OwnerBadge sha256:924f0028a409…