File size: 2,178 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
---
title: Heading
description: Used to render semantic HTML heading elements.
---
<ExampleTabs name="heading-basic" />
## Usage
```js
import { Heading } from "@chakra-ui/react"
```
```jsx
<Heading>I'm a Heading</Heading>
```
## Examples
### Sizes
Use the `size` prop to change the size of the heading component.
<ExampleTabs name="heading-with-sizes" />
### Highlight
Compose the `Heading` component with the `Highlight` component to highlight
text.
<ExampleTabs name="heading-with-highlight" />
### As another element
Use the `as` prop to render the heading as another HTML element.
<ExampleTabs name="heading-with-as-prop" />
### Weights
Use the `fontWeight` prop to change the weight of the heading component.
<ExampleTabs name="heading-with-weights" />
### Composition
Use the `Heading` component to compose other components.
<ExampleTabs name="heading-with-composition" />
## Customization
To override the `fontSize`, we recommend using the `textStyle` prop since it
considers the line height and letter spacing as well.
### Base style
Here's an example of customizing the `Heading` component.
```tsx title="provider.tsx"
import { createSystem, defineRecipe } from "@chakra-ui/react"
import { defaultConfig } from "@chakra-ui/react"
const headingRecipe = defineRecipe({
base: {
fontWeight: "normal",
textStyle: "4xl",
},
})
const system = createSystem(defaultConfig, {
theme: {
recipes: { heading: headingRecipe },
},
})
```
### Custom Size
Update the `variants.size` property to create a custom size.
```tsx title="provider.tsx"
import { createSystem, defineRecipe } from "@chakra-ui/react"
import { defaultConfig } from "@chakra-ui/react"
const headingRecipe = defineRecipe({
variants: {
size: {
custom: {
fontSize: "100px",
lineHeight: "100px",
letterSpacing: "-2px",
},
},
},
})
const system = createSystem(defaultConfig, {
theme: {
recipes: { heading: headingRecipe },
},
})
```
Then, use the `custom` variant to create a custom size.
```tsx
<Heading size="custom">I'm a custom size</Heading>
```
## Props
<PropTable component="Heading" part="Heading" />
|