Playground

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

Documented example billing-interval-subscription : ArrowDown from monthly, yearly selected and emitted.

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

The real BillingIntervalSelector, live
React
Vue

Events it emits: change. Use either render above, and each event shows here with the framework that sent it.

    Code

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

    import { BillingIntervalSelector } from '@oods/components-react';
    import '@oods/component-styles/css';
    
    const intervals = [
      "monthly",
      "yearly"
    ];
    
    export function Example() {
      return (
        <BillingIntervalSelector
          interval="monthly"
          intervals={intervals}
          label="Billing interval"
        />
      );
    }

    Props, slots and events

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

    Props
    PropTypeRequiredDocumented example
    help string | undefined no
    interval string | undefined no monthly
    intervals readonly string[] | undefined no ["monthly","yearly"]
    label string | undefined no Billing interval
    name string | undefined no
    disabled boolean | undefined no

    Slots

    none

    Events

    change

    States

    editing, invalid

    Accessibility

    Role
    combobox
    How it gets its name
    label on select

    Keyboard

    Keyboard
    KeyWhat it does
    TabMove focus to the named native control

    Obligations in the contract

    • A label names the native select
    • Native keyboard navigation selects an interval
    • An invalid value is visible with an associated alert and aria-invalid

    Billable interval selection emits one string from intervals. intervalField binds interval; intervalsParameter resolves to the declared object parameter. Defaults are Billable monthly/quarterly/annual; Subscription resolves monthly/yearly. An absent value has a disabled Choose interval placeholder; an invalid value remains visible as a disabled option plus an alert. HTML supplies the same static options and validation semantics.

    Tokens

    The token roles this component reads.

    • billing.interval.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.

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

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

    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.BillingIntervalSelector sha256:655f74dd8a74…
    • Documented example: @oods/component-contracts@0.10.1 sharedScenarios billing-interval-subscription sha256:5aa572cdd570…
    • Catalog entry (catalog_list): generated/0.10.1/system/catalog.json BillingIntervalSelector sha256:3e2221e47e06…
    • React readiness: @oods/components-react@0.10.1 readiness BillingIntervalSelector sha256:a85e10a318c8…
    • Vue readiness: @oods/components-vue@0.10.1 readiness BillingIntervalSelector sha256:9981c185aa7c…
    • Prop types: generated/0.10.1/components/prop-types.json BillingIntervalSelector sha256:a6f5a2ef4e37…