CycleProgressCard

Playground

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

Documented example billing-cycle-progress : mount, 40% complete · 18 days remaining.

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

export function Example() {
  return (
    <CycleProgressCard
      progress={0.4}
      periodStart="2026-01-01T00:00:00Z"
      periodEnd="2026-01-31T00:00:00Z"
      now="2026-01-13T00:00:00Z"
      interval="monthly"
    />
  );
}

Props, slots and events

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

Slots

none

Events

none

States

populated, 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

• Native semantic elements retain their names and content
• Billable cycle announces percentage and remaining days. Explicit progress wins over date-derived progress, except an ended period is always 100% with zero days. now is an injectable ISO clock; omission uses the current instant. Missing dates/progress produce named unavailable terms. Remaining days use ceil of the nonnegative UTC duration.

Billable cycle announces percentage and remaining days. Explicit progress wins over date-derived progress, except an ended period is always 100% with zero days. now is an injectable ISO clock; omission uses the current instant. Missing dates/progress produce named unavailable terms. Remaining days use ceil of the nonnegative UTC duration.

Tokens

The token roles this component reads.

• billing.text
• billing.surface
• billing.border

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.

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

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.CycleProgressCard sha256:3cf706499c65…
• Documented example: @oods/component-contracts@0.10.1 sharedScenarios billing-cycle-progress sha256:83eedafcc7c7…
• Catalog entry (catalog_list): generated/0.10.1/system/catalog.json CycleProgressCard sha256:75bc1188a7c5…
• React readiness: @oods/components-react@0.10.1 readiness CycleProgressCard sha256:1cb29c400e7b…
• Vue readiness: @oods/components-vue@0.10.1 readiness CycleProgressCard sha256:32b932c9090f…
• Prop types: generated/0.10.1/components/prop-types.json CycleProgressCard sha256:0b639203a8ef…