CancellationBadge

Playground

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

Documented example cancellation-badge-false : mount, No cancellation scheduled remains visible; machine status remains false; cancellation is the badge variant; with hideWhenFalse a false flag renders nothing and a true flag reads Cancellation scheduled.

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

export function Example() {
  return (
    <CancellationBadge
      cancelAtPeriodEnd={false}
    />
  );
}

Props, slots and events

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

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

• false remains visible
• cancellation is the badge variant

Mirrors renderCancellationBadge over renderBadgePrimitive: label/text/status/state/cancelAtPeriodEnd/value label precedence; status/state/cancelAtPeriodEnd/isCancelled/value status precedence; Cancellation fallback and cancellation variant. Boolean flags read No cancellation scheduled / Cancellation scheduled while preserving their recorded status; absent flags remain absent. field binds cancelAtPeriodEnd. With hideWhenFalse a false flag renders nothing (s223-m01: a card shows "Cancellation scheduled", never the default "No cancellation scheduled"); a true flag still reads Cancellation scheduled. Authored labels or children win. Noninteractive; no cancellation action.

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.

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

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.CancellationBadge sha256:a6fa56f0cb40…
• Documented example: @oods/component-contracts@0.10.1 sharedScenarios cancellation-badge-false sha256:a7706f3d395c…
• Catalog entry (catalog_list): generated/0.10.1/system/catalog.json CancellationBadge sha256:e17e5a6a5eea…
• React readiness: @oods/components-react@0.10.1 readiness CancellationBadge sha256:3e23b3e24bf2…
• Vue readiness: @oods/components-vue@0.10.1 readiness CancellationBadge sha256:324bd891d621…
• Prop types: generated/0.10.1/components/prop-types.json CancellationBadge sha256:ad3a8bd0841a…