BillingAmountInput

Playground

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

Documented example billing-amount-half-up : type 19.995, 2000 emitted; negative input emits nothing; blank emits undefined.

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

export function Example() {
  return (
    <BillingAmountInput
      amount={1999}
      currency="usd"
      minorUnits={100}
      label="Billing amount"
    />
  );
}

Props, slots and events

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

Slots

none

Events

change

States

editing, invalid

Accessibility

Role

textbox

How it gets its name

label on input

Keyboard

Obligations in the contract

• A label names the decimal input
• Currency describes the input
• Invalid input has an associated alert and aria-invalid

Billable amount is an integer number of minor units. Decimal major-unit edits emit number | undefined, rounded half up with decimal arithmetic; zero is valid, blank emits undefined, and negatives or unsafe values retain the draft and emit no update. amountField/currencyField bind runtime amount/currency; minorUnitsParameter resolves to the declared object parameter. Uncontrolled text is retained until amount/minorUnits changes. HTML supplies the same static value and validation semantics; framework components own updates.

Tokens

The token roles this component reads.

• billing.amount.text
• billing.currency.text
• input.border
• input.background
• input.validation

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.

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

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.BillingAmountInput sha256:8e1449aaed60…
• Documented example: @oods/component-contracts@0.10.1 sharedScenarios billing-amount-half-up sha256:1b01d87f7580…
• Catalog entry (catalog_list): generated/0.10.1/system/catalog.json BillingAmountInput sha256:68f0e555d7cc…
• React readiness: @oods/components-react@0.10.1 readiness BillingAmountInput sha256:e19067fb979e…
• Vue readiness: @oods/components-vue@0.10.1 readiness BillingAmountInput sha256:5a705ab4d170…
• Prop types: generated/0.10.1/components/prop-types.json BillingAmountInput sha256:0ef7a6c34601…