Heading

Headings are used for rendering headlines.

Heading composes Box so you can use all the style props and add responsive styles as well. It renders an <h2> tag by default.

View source View theme source @chakra-ui/layout

Import#

import { Heading } from '@chakra-ui/react'

Usage#

<Heading>I'm a Heading</Heading>

Changing font size#

To increase the size of the heading, you can use the fontSize or size props. If you use the size prop, the font size of the heading will automatically decrease in size for smaller screens, but only by using size lg or above with the default theme. This can be seen in the theme source for the component.

<Stack spacing={6}>
  <Heading as='h1' size='4xl' noOfLines={1}>
    (4xl) In love with React & Next
  </Heading>
  <Heading as='h2' size='3xl' noOfLines={1}>
    (3xl) In love with React & Next
  </Heading>
  <Heading as='h2' size='2xl'>
    (2xl) In love with React & Next
  </Heading>
  <Heading as='h2' size='xl'>
    (xl) In love with React & Next
  </Heading>
  <Heading as='h3' size='lg'>
    (lg) In love with React & Next
  </Heading>
  <Heading as='h4' size='md'>
    (md) In love with React & Next
  </Heading>
  <Heading as='h5' size='sm'>
    (sm) In love with React & Next
  </Heading>
  <Heading as='h6' size='xs'>
    (xs) In love with React & Next
  </Heading>
</Stack>

Truncate heading#

If you'd like to truncate the heading after a specific number of lines, pass the noOfLines prop. This will render an ellipsis when the heading exceeds the width of the viewport or maxWidth prop.

<Heading noOfLines={1}>
  Basic text writing, including headings, body text, lists, and more.
</Heading>

Override style#

You can override the size of the Heading component by passing the fontSize prop. No need to write css or styled().

<Heading size='lg' fontSize='50px'>
  I'm overriding this heading
</Heading>

Composition#

// Example from paystack.com

<Box maxW='32rem'>
  <Heading mb={4}>Modern online and offline payments for Africa</Heading>
  <Text fontSize='xl'>
    Paystack helps businesses in Africa get paid by anyone, anywhere in the
    world
  </Text>
  <Button size='lg' colorScheme='green' mt='24px'>
    Create a free account
  </Button>
</Box>

Props#

The Heading composes the Box component, so you can pass all Box props.

`colorScheme`

Description

Color Schemes for Heading are not implemented in the default theme. You can extend the theme to implement them.

Type

(string & {})

`orientation`

Type

"horizontal" | "vertical"

`size`

Type

"4xl" | "3xl" | "2xl" | "xl" | "lg" | "md" | "sm" | "xs"

Default

"xl"

`styleConfig`

Type

Dict<any>

`variant`

Description

Variants for Heading are not implemented in the default theme. You can extend the theme to implement them.

Type

string