TagPills

Playground

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

Documented example tag-pills-overflow-template : mount, three visible pills and the overflow label +5, the template substituted with the total tag count as in the HTML renderer.

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

const tags = [
  "alpha",
  "beta",
  "gamma",
  "delta",
  "epsilon"
];

export function Example() {
  return (
    <TagPills
      tags={tags}
      maxVisible={3}
      overflowLabel={"+{{ tag_count }}"}
    />
  );
}

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, overflow, empty

Accessibility

Role

none

How it gets its name

none on :root

Keyboard

The contract lists no keyboard behaviour.

Obligations in the contract

• Each visible tag is text inside one noninteractive group
• The overflow label is visible text

Mirrors renderTagPills with data-summary-type=tag-pills: tags, then value (records read label/name/role/value/id, scalars render as text) render one data-tag-pill each up to maxVisible (a number or numeric string; default every tag); when tags remain, overflowLabel replaces {{ tag_count }} with the total tag count exactly as the HTML renderer does, or +N with the hidden count without a template; authored children replace the pills. The generic field lowers to tags; the saved-schema label is consumed and left unbound because the renderer never reads it.

Tokens

The token roles this component reads.

• badge.background
• badge.text

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.

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

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.TagPills sha256:a5e93aa63dcd…
• Documented example: @oods/component-contracts@0.10.1 sharedScenarios tag-pills-overflow-template sha256:ea57ee504ac8…
• Catalog entry (catalog_list): generated/0.10.1/system/catalog.json TagPills sha256:29fd1300ad34…
• React readiness: @oods/components-react@0.10.1 readiness TagPills sha256:bf97754d7f01…
• Vue readiness: @oods/components-vue@0.10.1 readiness TagPills sha256:d1938890a8a2…
• Prop types: generated/0.10.1/components/prop-types.json TagPills sha256:348bf00b7c09…