Playground

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

Documented example GeocodablePreview : mount and declared input triggers, A named section renders resolution, an explicit Yes/No/unknown lookup requirement and detected field names. It is a data summary, not a map or geocoding result..

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

The real GeocodablePreview, live
React

Geographic data

Resolution
point
Requires lookup
No
Detected fields
lat, lon
Vue

Geographic data

Resolution
point
Requires lookup
No
Detected fields
lat, lon

Code

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

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

const detectedFields = [
  {
    "name": "lat"
  },
  {
    "name": "lon"
  }
];

export function Example() {
  return (
    <GeocodablePreview
      resolution="point"
      requiresLookup={false}
      detectedFields={detectedFields}
    />
  );
}

Props, slots and events

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

Props
PropTypeRequiredDocumented example
title string | undefined no
resolution string | undefined no point
requiresLookup boolean | undefined no false
detectedFields readonly unknown[] | undefined no [{"name":"lat"},{"name":"lon"}]

Slots

none

Events

none

States

empty, populated

Accessibility

Role
region
How it gets its name
aria-label on [data-oods-component="GeocodablePreview"]

Keyboard

The contract lists no keyboard behaviour.

Obligations in the contract

  • Visible text exposes values without relying on color
  • Named semantic container or noninteractive span

A named section renders resolution, an explicit Yes/No/unknown lookup requirement and detected field names. It is a data summary, not a map or geocoding result.

Tokens

The token roles this component reads.

  • surface.panel
  • text.body

Readiness

The evidence recorded for this component, with its label.

react-and-vue: catalog_list gives this label when the React and Vue components have complete readiness evidence, but the sweep's generated apps don't use the component in both.

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

GeocodablePreview presents declared trait values and owns no focusable control or consumer action.

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

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.GeocodablePreview sha256:cb16e935d873…
  • Documented example: @oods/component-contracts@0.10.1 sharedScenarios GeocodablePreview sha256:eea15e6493cf…
  • Catalog entry (catalog_list): generated/0.10.1/system/catalog.json GeocodablePreview sha256:65b35927cbd6…
  • React readiness: @oods/components-react@0.10.1 readiness GeocodablePreview sha256:e5dc691c8e38…
  • Vue readiness: @oods/components-vue@0.10.1 readiness GeocodablePreview sha256:65173e52cafa…
  • Prop types: generated/0.10.1/components/prop-types.json GeocodablePreview sha256:6ff315727959…