Heading

RSC

Generates headings from h1 to h6 with different sizes and semantic meanings.

Installation

API Reference

Important Note

This is the documentation for gluestack-ui v2 (beta). For @gluestack-ui/themed (stable) documentation, refer to gluestack-ui v1.

This is an illustration of Heading component.

<Heading>I am a Heading</Heading>

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add heading

Step 1: Copy and paste the following code into index.tsx in your project.

import React, { forwardRef, memo } from "react"
import { H1, H2, H3, H4, H5, H6 } from "@expo/html-elements"
import { cssInterop } from "nativewind"
import { headingStyle } from "./styles"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"

type IHeadingProps = VariantProps<typeof headingStyle> &
  React.ComponentProps<typeof H1>

cssInterop(H1, { className: "style" })
cssInterop(H2, { className: "style" })
cssInterop(H3, { className: "style" })
cssInterop(H4, { className: "style" })
cssInterop(H5, { className: "style" })
cssInterop(H6, { className: "style" })

const MappedHeading = memo(
  forwardRef(
    (
      {
        size,
        className,
        isTruncated,
        bold,
        underline,
        strikeThrough,
        sub,
        italic,
        highlight,
        ...props
      }: IHeadingProps,
      ref?: any
    ) => {
      switch (size) {
        case "5xl":
        case "4xl":
        case "3xl":
          return (
            <H1
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        case "2xl":
          return (
            <H2
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        case "xl":
          return (
            <H3
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        case "lg":
          return (
            <H4
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        case "md":
          return (
            <H5
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        case "sm":
        case "xs":
          return (
            <H6
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        default:
          return (
            <H4
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
      }
    }
  )
)
const Heading = memo(
  forwardRef(
    (
      {
        className,
        size = "lg",
        as: AsComp,
        ...props
      }: IHeadingProps & {
        as?: React.ElementType
      },
      ref?: any
    ) => {
      const {
        isTruncated,
        bold,
        underline,
        strikeThrough,
        sub,
        italic,
        highlight,
      } = props

      if (AsComp) {
        return (
          <AsComp
            className={headingStyle({
              size,
              isTruncated,
              bold,
              underline,
              strikeThrough,
              sub,
              italic,
              highlight,
              class: className,
            })}
            {...props}
          />
        )
      }

      return (
        <MappedHeading className={className} size={size} ref={ref} {...props} />
      )
    }
  )
)

Heading.displayName = "Heading"

export { Heading }

Important Note

Note: Step 2 is optional and only required if you want to add support for React Server Components, You can skip this and jump to Step 3 directly if you don't have this requirement.

Step 2(optional): Copy and paste the following code into index.web.tsx in your project.

import React, { forwardRef, memo } from "react"
import { headingStyle } from "./styles"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"
type IHeadingProps = VariantProps<typeof headingStyle> &
  React.ComponentProps<"h1">

const MappedHeading = memo(
  forwardRef(
    (
      {
        size,
        className,
        isTruncated,
        bold,
        underline,
        strikeThrough,
        sub,
        italic,
        highlight,
        ...props
      }: IHeadingProps,
      ref?: any
    ) => {
      switch (size) {
        case "5xl":
        case "4xl":
        case "3xl":
          return (
            <h1
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        case "2xl":
          return (
            <h2
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        case "xl":
          return (
            <h3
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        case "lg":
          return (
            <h4
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        case "md":
          return (
            <h5
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        case "sm":
        case "xs":
          return (
            <h6
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
        default:
          return (
            <h4
              className={headingStyle({
                size,
                isTruncated,
                bold,
                underline,
                strikeThrough,
                sub,
                italic,
                highlight,
                class: className,
              })}
              {...props}
              ref={ref}
            />
          )
      }
    }
  )
)

const Heading = memo(
  forwardRef(
    (
      {
        className,
        size = "lg",
        as: AsComp,
        ...props
      }: IHeadingProps & {
        as?: React.ElementType
      },
      ref?: any
    ) => {
      const {
        isTruncated,
        bold,
        underline,
        strikeThrough,
        sub,
        italic,
        highlight,
      } = props
      if (AsComp) {
        return (
          <AsComp
            className={headingStyle({
              size,
              isTruncated,
              bold,
              underline,
              strikeThrough,
              sub,
              italic,
              highlight,
              class: className,
            })}
            {...props}
            ref={ref}
          />
        )
      }

      return (
        <MappedHeading className={className} size={size} ref={ref} {...props} />
      )
    }
  )
)

Heading.displayName = "Heading"

export { Heading }

Step 3: Copy and paste the following code into styles.tsx in your project.

import { tva } from "@gluestack-ui/nativewind-utils/tva"
import { isWeb } from "@gluestack-ui/nativewind-utils/IsWeb"
const baseStyle = isWeb
  ? "font-sans tracking-sm bg-transparent border-0 box-border display-inline list-none margin-0 padding-0 position-relative text-start no-underline whitespace-pre-wrap word-wrap-break-word"
  : ""

export const headingStyle = tva({
  base: `text-typography-900 font-bold font-heading tracking-sm my-0 ${baseStyle}`,
  variants: {
    isTruncated: {
      true: "truncate",
    },
    bold: {
      true: "font-bold",
    },
    underline: {
      true: "underline",
    },
    strikeThrough: {
      true: "line-through",
    },
    sub: {
      true: "text-xs",
    },
    italic: {
      true: "italic",
    },
    highlight: {
      true: "bg-yellow-500",
    },
    size: {
      "5xl": "text-6xl",
      "4xl": "text-5xl",
      "3xl": "text-4xl",
      "2xl": "text-3xl",
      xl: "text-2xl",
      lg: "text-xl",
      md: "text-lg",
      sm: "text-base",
      xs: "text-sm",
    },
  },
})

Step 4: Update the import paths to match your project setup.

API Reference

To use this component in your project, include the following import statement in your file.

import { Heading } from "@/components/ui/heading"

export default () => <Heading />

Component Props

This section provides a comprehensive reference list for the component props, detailing descriptions, properties, types, and default behavior for easy project integration.

Heading

It inherits all the properties of @expo/html-elements's H1 component.

Props

Heading

Heading component is created using H1 component from @expo/html-elements. It extends all the props supported by Expo HTML Heading Elements, utility props and the props mentioned below.

Name	Value	Default
isTruncated	true \| false	false
bold	true \| false	false
underline	true \| false	false
strikeThrough	true \| false	false
sub	true \| false	false
italic	true \| false	false
highlight	true \| false	false
size	5xl \| 4xl \| 3xl \| 2xl \| xl \| lg \| md \| sm \| xs	md

Examples

The Examples section provides visual representations of the different variants of the component, allowing you to quickly and easily determine which one best fits your needs. Simply copy the code and integrate it into your project.

Heading Sizes

Heading component offers a range of sizes, including xs, sm, md, lg, xl, 2xl, 3xl, 4xl, and 5xl, allowing users to customize the size of the heading according to their design requirements.

function App() {
  const sizes = ["xs", "sm", "md", "lg", "xl", "2xl", "3xl", "4xl", "5xl"]
  return (
    <Center>
      {sizes.map((size) => (
        <Heading size={size}>{size}</Heading>
      ))}
    </Center>
  )
}