CommunicationDetailPanel

Playground

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

Documented example CommunicationDetailPanel : mount and declared input triggers, A named read-only section renders declared channel, template, delivery policy and conversation entries. A polite status announces the conversation count; it performs no delivery or network operation..

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

const channels = [
  {
    "name": "Email"
  }
];

const templates = [
  {
    "name": "Welcome"
  }
];

const policies = [
  {
    "name": "Retry once"
  }
];

const conversations = [
  {
    "name": "Support",
    "status": "delivered"
  }
];

export function Example() {
  return (
    <CommunicationDetailPanel
      channels={channels}
      templates={templates}
      policies={policies}
      conversations={conversations}
    />
  );
}

Props, slots and events

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

Slots

none

Events

none

States

empty, populated

Accessibility

Role

region

How it gets its name

aria-label on [data-oods-component="CommunicationDetailPanel"]

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 read-only section renders declared channel, template, delivery policy and conversation entries. A polite status announces the conversation count; it performs no delivery or network operation.

Tokens

The token roles this component reads.

• surface.panel
• text.body

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.

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

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.CommunicationDetailPanel sha256:9c2498e16d82…
• Documented example: @oods/component-contracts@0.10.1 sharedScenarios CommunicationDetailPanel sha256:033bba88954b…
• Catalog entry (catalog_list): generated/0.10.1/system/catalog.json CommunicationDetailPanel sha256:73f7bf9b6830…
• React readiness: @oods/components-react@0.10.1 readiness CommunicationDetailPanel sha256:59fa04eea8fc…
• Vue readiness: @oods/components-vue@0.10.1 readiness CommunicationDetailPanel sha256:e3730e844a64…
• Prop types: generated/0.10.1/components/prop-types.json CommunicationDetailPanel sha256:0e366bca33a5…