{
  "id": "uilib/components/heading",
  "name": "Heading",
  "description": "The Heading component is a helper to create automated semantic headings within a boundary of some rules.",
  "group": "components",
  "slug": "/uilib/components/heading/",
  "props": [
    {
      "name": "text",
      "doc": "A heading, can be text or React.Node.",
      "type": "React.Node",
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "children",
      "doc": "A heading, can be text or React.Node.",
      "type": "React.Node",
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "size",
      "doc": "Define the typography [font-size](/uilib/typography/font-size) by a size _type_, e.g. `x-large`. Defaults to the predefined heading sizes.",
      "type": [
        "xx-large",
        "x-large",
        "large",
        "medium",
        "basis",
        "small",
        "x-small"
      ],
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "level",
      "doc": "Overwrite the automated level handling to use a specific value to ensure correct level hierarchy.",
      "type": [
        "1",
        "2",
        "3",
        "4",
        "5",
        "6"
      ],
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "increase",
      "doc": "If set to `true`, the heading level will be incremented by 1.",
      "type": "boolean",
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "decrease",
      "doc": "If set to `true`, the heading level will be decremented by 1.",
      "type": "boolean",
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "inherit",
      "doc": "If set to `true`, the heading last used level will be inherited. Also from inside a level context.",
      "type": "boolean",
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "reset",
      "doc": "If set to `true`, the heading level will be reset to 2. You can give it a custom level if you need to, e.g. `reset(1)`.",
      "type": [
        "boolean",
        "number"
      ],
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "skip_correction",
      "doc": "If set to `true`, the heading will not be corrected and warnings will not be shown. Warnings do not show up in **production builds** else either",
      "type": "boolean",
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "debug",
      "doc": "If set to `true`, the content will have a prefix, showing the heading level.",
      "type": [
        "boolean",
        "function"
      ],
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "debug_counter",
      "doc": "If set to `true`, the content will have both a prefix and a JSON log attached to both headings and level contexts.",
      "type": [
        "boolean",
        "function"
      ],
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "element",
      "doc": "define what HTML element should be used. If you use, e.g. a `span`, then `role=\"heading\"` and `aria-level` gets set. Defaults to semantic heading element.",
      "type": [
        "string",
        "React.Element"
      ],
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "skeleton",
      "doc": "If set to `true`, an overlaying skeleton with animation will be shown.",
      "type": "boolean",
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "proseMaxWidth",
      "doc": "Sets the maximum width based on character count. This will limit the text width to approximately the specified number of characters. Use `true` for a default value of 60ch.",
      "type": [
        "number",
        "boolean"
      ],
      "status": "optional",
      "defaultValue": null
    }
  ],
  "events": [],
  "related": [
    "Space"
  ],
  "checksum": "95dc45d70dc36925cb2d926b134242ce20d74d818fdaacc2e774471daf6d0adf",
  "source": {
    "repo": "https://github.com/dnbexperience/eufemia",
    "file": "packages/dnb-eufemia/src/components/heading/Heading.tsx",
    "permalink": "https://github.com/dnbexperience/eufemia/blob/main/packages/dnb-eufemia/src/components/heading/Heading.tsx"
  },
  "sources": {
    "entry": {
      "local": "src/docs/uilib/components/heading.mdx",
      "public": "https://d3bdcd79.eufemia-e25.pages.dev/uilib/components/heading/"
    },
    "props": {
      "local": "src/docs/uilib/components/heading/properties.mdx",
      "public": "https://d3bdcd79.eufemia-e25.pages.dev/uilib/components/heading/properties/"
    },
    "events": null,
    "demos": {
      "local": "src/docs/uilib/components/heading/demos.mdx",
      "public": "https://d3bdcd79.eufemia-e25.pages.dev/uilib/components/heading/demos/"
    }
  },
  "version": "0.0.0-development",
  "generatedAt": "2025-12-18T09:47:40.882Z",
  "schemaVersion": 1
}