{"componentChunkName":"component---src-pages-api-heading-mdx","path":"/api/heading/","result":{"pageContext":{"frontmatter":{"pageTitle":"Heading API","title":"Heading","props":["HeadingProps"]},"properties":[{"name":"HeadingProps","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"tags":[{"tag":"children","text":"required\n"}]},"id":"HeadingProps","tags":{"children":"required"},"properties":{"as":{"name":"as","required":false,"type":{"name":"string"},"deprecated":false},"children":{"name":"children","required":false,"type":{"name":"any"},"description":"The content of the component","deprecated":false},"color":{"name":"color","required":false,"type":{"name":"enum","options":["TypographyColor.danger","TypographyColor.default","TypographyColor.subdued","TypographyColor.success"]},"description":"The color of the component, that helps to convey meaning or relative emphasis","defaultValue":"TypographyColor.default","deprecated":false},"contextVariant":{"name":"contextVariant","required":false,"type":{"name":"enum","options":["TypographyContextVariant.default","TypographyContextVariant.expressive","TypographyContextVariant.narrative"]},"description":"Additional styles for typography based on the context of the content","defaultValue":"TypographyColor.default","deprecated":false},"element":{"name":"element","required":false,"type":{"name":"string"},"deprecated":false},"isInverse":{"name":"isInverse","required":false,"type":{"name":"boolean"},"description":"If true, the component will have inverse styling to better appear on a dark background","defaultValue":"false","deprecated":false},"level":{"name":"level","required":true,"type":{"name":"1 | 2 | 3 | 4 | 5 | 6"},"description":"Number to indicate which level heading will render (e.g. h1, h2 etc.)","deprecated":false},"noMargins":{"name":"noMargins","required":false,"type":{"name":"boolean"},"deprecated":false},"ref":{"name":"ref","required":false,"type":{"name":"any"},"deprecated":false},"testId":{"name":"testId","required":false,"type":{"name":"string"},"description":"Test ID attached to an internal element as `data-testid` for consumer testing","deprecated":false},"theme":{"name":"theme","required":false,"type":{"name":"any"},"deprecated":false},"visualStyle":{"name":"visualStyle","required":false,"type":{"name":"enum","options":["TypographyVisualStyle.bodyLarge","TypographyVisualStyle.bodyMedium","TypographyVisualStyle.bodySmall","TypographyVisualStyle.bodyXSmall","TypographyVisualStyle.heading2XSmall","TypographyVisualStyle.headingLarge","TypographyVisualStyle.headingMedium","TypographyVisualStyle.headingSmall","TypographyVisualStyle.headingXLarge","TypographyVisualStyle.headingXSmall"]},"description":"Applies visual styles including font-size, font-weight, line-height and margins","deprecated":false}}}]}},"staticQueryHashes":["3821761011"]}