TagSummary

Playground

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

Documented example tag-summary-zero-and-tags : mount, zero count remains visible; typed tag entries render normalized visible names.

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

const tags = [
  "alpha",
  {
    "name": "beta"
  }
];

export function Example() {
  return (
    <TagSummary
      tagCount={0}
      tags={tags}
    />
  );
}

Props, slots and events

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

Slots

default

Events

none

States

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

• zero count remains visible
• typed tag entries render normalized visible names

Preserves renderTagSummary scalar summary semantics: title/label/heading/name (default Tag Summary), Tag Count tagCount/count, Tags tags; summary/text/description fallback; children replace the description-list body but keep the h3. field lowers to tags and countField to tagCount. Adds typed array presentation required by Taggable: the existing tag normalizer resolves label/name/role/value/id and joins visible names with comma-space, unlike the HTML scalar reader which ignores arrays. Empty arrays omit the Tags term; numeric zero count remains visible. Noninteractive; no tagging action is implied.

Tokens

The token roles this component reads.

• summary.background
• summary.border
• summary.text
• summary.label

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.

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

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.TagSummary sha256:677bb79cbb78…
• Documented example: @oods/component-contracts@0.10.1 sharedScenarios tag-summary-zero-and-tags sha256:e2792ce321dc…
• Catalog entry (catalog_list): generated/0.10.1/system/catalog.json TagSummary sha256:09d0cff50998…
• React readiness: @oods/components-react@0.10.1 readiness TagSummary sha256:767d2fbe359b…
• Vue readiness: @oods/components-vue@0.10.1 readiness TagSummary sha256:660cfc3ee147…
• Prop types: generated/0.10.1/components/prop-types.json TagSummary sha256:b926a67c500c…