{
  "name": "DescriptionListItem",
  "source": "src/components/DescriptionList.tsx",
  "propsType": "DescriptionListItemProps",
  "import": "import { DescriptionListItem } from 'ionbase-ui';",
  "status": "stable",
  "summary": "One term and its value inside a DescriptionList: a `<div>` holding a `<dt>` and a `<dd>`.",
  "useWhen": [
    "one label–value pair in a DescriptionList"
  ],
  "a11y": {
    "requires": [
      "a DescriptionList parent — a `<dt>` outside a `<dl>` is invalid, and is not read as a term"
    ],
    "guarantees": [
      "`term` is the `<dt>`; the children are the `<dd>`",
      "empty children are drawn as \"—\" and read as the list's `emptyText`"
    ]
  },
  "antiPatterns": [
    {
      "dont": "a typed \"—\", \"N/A\" or \"None\" as the value",
      "do": "null, and let the list say it",
      "why": "the list draws the dash and reads its translated `emptyText`; a typed one is read as \"dash\" and is not translated"
    }
  ],
  "stylesheet": "src/styles/description-list.css",
  "tokens": [
    "--font-family-sans",
    "--spacing-12",
    "--spacing-2",
    "--spacing-32",
    "--spacing-8",
    "--text-default",
    "--text-secondary",
    "--text-tertiary",
    "--type-body-sm",
    "--type-body-sm-line-height"
  ],
  "props": {
    "term": {
      "type": "React.ReactNode",
      "required": true,
      "origin": "own",
      "description": "The label — \"Owner\", \"Started\". Rendered as the `<dt>`."
    },
    "children": {
      "type": "React.ReactNode",
      "required": false,
      "origin": "own",
      "description": "The value, rendered as the `<dd>`. `null`, `undefined`, `false` or ''\nrender as an empty value: \"—\" to the eye, `emptyText` to a reader."
    },
    "emptyText": {
      "type": "string | undefined",
      "required": false,
      "origin": "own",
      "description": "Set by the DescriptionList; pass it here only to override one item."
    }
  },
  "propCounts": {
    "own": 3,
    "aria": 0,
    "dom": 277,
    "other": 0
  }
}