Heading

Heading allows you to show headings on the page & has a bigger line height than regular text.

Props

Component props
Name	Type	Default
`accessibilityLevel`	`1 \| 2 \| 3 \| 4 \| 5 \| 6 \| "none"`	-
	Allows you to override the default heading level for the given `size`.
`align`	`"start" \| "end" \| "center" \| "justify" \| "forceLeft" \| "forceRight"`	`"start"`
	`"start"` and `"end"` should be used for regular alignment since they flip with locale direction. `"forceLeft"` and `"forceRight"` should only be used in special cases where locale direction should be ignored, such as tabular or numeric text. See Align example for more details.
`children`	`React.Node`	-
`color`	`"blue" \| "darkGray" \| "eggplant" \| "gray" \| "green" \| "lightGray" \| "maroon" \| "midnight" \| "navy" \| "olive" \| "orange" \| "orchid" \| "pine" \| "purple" \| "red" \| "watermelon" \| "white"`	`"darkGray"`
	The color of the text. See Colors example for more details.
`id`	`string`	-
	A unique identifier for the element.
`lineClamp`	`number`	-
	Visually truncate the text to the specified number of lines. This also adds the `title` attribute if `children` is a string, which displays the full text on hover in most browsers. See Truncation example for more details.
`overflow`	`"normal" \| "breakWord"`	`"breakWord"`
	How truncation is handled when text overflows the line. See Truncation example for more details.
`size`	`"sm" \| "md" \| "lg"`	`"lg"`
	The font size of the text. See Sizes example for more details. sm: 20px, md: 28px, lg: 36px

Example: Sizes

<Box maxWidth="8em">
  <Heading size="sm">Heading small</Heading>
  <span lang="ja">
    <Heading size="sm">こんにちは</Heading>
  </span>

  <span>
    <Heading size="md">Heading medium</Heading>
  </span>{' '}
  <span lang="ja">
    <Heading size="md">こんにちは</Heading>
  </span>

  <Heading size="lg">Heading large</Heading>
  <span lang="ja">
    <Heading size="lg">こんにちは</Heading>
  </span>
</Box>

<Box maxWidth="8em">
  <Heading size="sm">Heading small</Heading>
  <span lang="ja">
    <Heading size="sm">こんにちは</Heading>
  </span>

  <span>
    <Heading size="md">Heading medium</Heading>
  </span>{' '}
  <span lang="ja">
    <Heading size="md">こんにちは</Heading>
  </span>

  <Heading size="lg">Heading large</Heading>
  <span lang="ja">
    <Heading size="lg">こんにちは</Heading>
  </span>
</Box>

Example: Colors

<Box>
  <Box margin={-1}>
    <Box color="gray" padding={1}>
      <Heading color="white" size="md">
        White
      </Heading>
    </Box>
  </Box>

  <Heading size="md">
    Dark gray (default)
  </Heading>

  <Heading color="gray" size="md">
    Gray
  </Heading>

  <Heading color="blue" size="md">
    Blue
  </Heading>

  <Heading color="red" size="md">
    Red
  </Heading>
</Box>

<Box>
  <Box margin={-1}>
    <Box color="gray" padding={1}>
      <Heading color="white" size="md">
        White
      </Heading>
    </Box>
  </Box>

  <Heading size="md">
    Dark gray (default)
  </Heading>

  <Heading color="gray" size="md">
    Gray
  </Heading>

  <Heading color="blue" size="md">
    Blue
  </Heading>

  <Heading color="red" size="md">
    Red
  </Heading>
</Box>

Example: Overflow & truncation

<Box maxWidth={240} marginTop={-2} marginBottom={-2}>
  <Box paddingY={2}>
    <Text>breakWord (default):</Text>
    <Heading size="sm" overflow="breakWord" >
      This is a long and Supercalifragilisticexpialidocious sentence.
      次の単語グレートブリテンおよび北アイルランド連合王国で本当に大きな言葉
    </Heading>
  </Box>

  <Box paddingY={2}>
    <Text>normal:</Text>
    <Heading size="sm" overflow="normal">
      This is a long and Supercalifragilisticexpialidocious sentence.
      次の単語グレートブリテンおよび北アイルランド連合王国で本当に大きな言葉
    </Heading>
  </Box>

  <Box paddingY={2}>
    <Text>lineClamp:</Text>
    <Heading size="sm" lineClamp={2}>
      This is a long and Supercalifragilisticexpialidocious sentence.
      次の単語グレートブリテンおよび北アイルランド連合王国で本当に大きな言葉
    </Heading>
  </Box>
</Box>

<Box maxWidth={240} marginTop={-2} marginBottom={-2}>
  <Box paddingY={2}>
    <Text>breakWord (default):</Text>
    <Heading size="sm" overflow="breakWord" >
      This is a long and Supercalifragilisticexpialidocious sentence.
      次の単語グレートブリテンおよび北アイルランド連合王国で本当に大きな言葉
    </Heading>
  </Box>

  <Box paddingY={2}>
    <Text>normal:</Text>
    <Heading size="sm" overflow="normal">
      This is a long and Supercalifragilisticexpialidocious sentence.
      次の単語グレートブリテンおよび北アイルランド連合王国で本当に大きな言葉
    </Heading>
  </Box>

  <Box paddingY={2}>
    <Text>lineClamp:</Text>
    <Heading size="sm" lineClamp={2}>
      This is a long and Supercalifragilisticexpialidocious sentence.
      次の単語グレートブリテンおよび北アイルランド連合王国で本当に大きな言葉
    </Heading>
  </Box>
</Box>

Example: Alignment

<Box maxWidth="24em">
  <Heading align="start" size="sm">Start-aligned heading (default)</Heading>
  <Heading align="end" size="sm">End-aligned heading</Heading>
  <Heading align="center" size="sm">Center-aligned heading</Heading>
  <Heading align="justify" size="sm">Justify-aligned heading</Heading>
  <Heading align="forceLeft" size="sm">Forced-left-aligned heading</Heading>
  <Heading align="forceRight" size="sm">Forced-right-aligned heading</Heading>
</Box>

<Box maxWidth="24em">
  <Heading align="start" size="sm">Start-aligned heading (default)</Heading>
  <Heading align="end" size="sm">End-aligned heading</Heading>
  <Heading align="center" size="sm">Center-aligned heading</Heading>
  <Heading align="justify" size="sm">Justify-aligned heading</Heading>
  <Heading align="forceLeft" size="sm">Forced-left-aligned heading</Heading>
  <Heading align="forceRight" size="sm">Forced-right-aligned heading</Heading>
</Box>

Example: Levels

For accessibility purposes, we allow you to override the heading level. We should have one level 1 per page & levels should be appropriately nested. E.g. level 1 followed by level 2 & level 2 followed by level 2 or level 3. We also allow headings without an accessibility level.

<Box>
  <Heading size="md" accessibilityLevel={2}>
    Medium heading level 2
  </Heading>
  <Heading size="sm" accessibilityLevel={3}>
    Small heading level 3
  </Heading>
  <Heading size="sm" accessibilityLevel="none">
    Small heading without a level
  </Heading>
</Box>

<Box>
  <Heading size="md" accessibilityLevel={2}>
    Medium heading level 2
  </Heading>
  <Heading size="sm" accessibilityLevel={3}>
    Small heading level 3
  </Heading>
  <Heading size="sm" accessibilityLevel="none">
    Small heading without a level
  </Heading>
</Box>

Edit page on GitHub