Stat

As the name implies, the `Stat` component is used to display some statistics.

Props#

StatLabel, StatHelpText, StatNumber composes Text component.
StatArrow composes Icon component.
Stat and StatGroup composes Box component.

`colorScheme`

Description

The visual color appearance of the component

Type

"whiteAlpha" | "blackAlpha" | "gray" | "red" | "orange" | "yellow" | "green" | "teal" | "blue" | "cyan" | "purple" | "pink"

`size`

Description

The size of the Stat

Type

"md"

Default

md

`variant`

Description

The variant of the Stat

Type

string

The Stat component is a multipart component. The styling needs to be applied to each part specifically.

To learn more about styling multipart components, visit the Component Style page.

Anatomy#

A: container
B: label
C: helpText
D: number
E: icon

Theming properties#

The properties that affect the theming of the Stat component are:

size: The size of the stat. Defaults to md.

Theming utilities#

createMultiStyleConfigHelpers: a function that returns a set of utilities for creating style configs for a multipart component (definePartsStyle and defineMultiStyleConfig).
definePartsStyle: a function used to create multipart style objects.
defineMultiStyleConfig: a function used to define the style configuration for a multipart component.

import { statAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(statAnatomy.keys)

Customizing the default theme#

import { statAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(statAnatomy.keys)

const baseStyle = definePartsStyle({
  // define the parts you're going to style
  label: {
    fontWeight: 'light',
    color: 'red',
  },
  helpText: {},
  container: {},
  icon: {},
  number: {},
})

export const statTheme = defineMultiStyleConfig({ baseStyle })

After customizing the stat theme, we can import it in our theme file and add it in the components property:

import { extendTheme } from '@chakra-ui/react'
import { statTheme } from './components/stat.ts'

export const theme = extendTheme({
  components: { Stat: statTheme },
})

This is a crucial step to make sure that any changes that we make to the stat theme are applied.

Adding a custom size#

Let's assume we want to include new extra small stat size. Here's how we can do that:

import { statAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(statAnatomy.keys)

export const statTheme = defineMultiStyleConfig({
  sizes: {
    // define the styles for this size variant
    xs: definePartsStyle({
      label: { fontSize: "xs" },
      helpText: { fontSize: "xs" },
      number: { fontSize: "xs" },
    }),
  }
})


// Now we can use the new `xs` size
<Stat size="xs" ... />

Every time you're adding anything new to the theme, you'd need to run the CLI command to get proper autocomplete in your IDE. You can learn more about the CLI tool here.

Adding a custom variant#

Let's assume we want to include a custom pill variant. Here's how we can do that:

import { statAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(statAnatomy.keys)

const danger = definePartsStyle({
  container: {
    background: "red.100",
    borderRadius: "lg",
    padding: "4"
  },
  helpText: {
    fontWeight: "bold"
  },
  label: {
    color: "red.500"
  },
  number: {
    fontStyle: "italic"
  }
})

export const statTheme = defineMultiStyleConfig({
  variants: { danger },
})

// Now we can use the new `danger` variant
<Stat variant={"danger"} .../>

Showcase#

import { useColorMode,IconButton, StatGroup, Box, Stat, StatArrow, StatHelpText, StatLabel, StatNumber } from "@chakra-ui/react";
import { FaMoon, FaSun } from "react-icons/fa";

export default function App() {
  const { toggleColorMode, colorMode } = useColorMode();
  return (
    <Box position="relative" h="100vh" p={12}>
        <StatGroup gap={12}>
            <Stat variant="great">
              <StatLabel>Sent</StatLabel>
              <StatNumber>345,670</StatNumber>
              <StatHelpText>
                <StatArrow type='increase' />
                23.36%
              </StatHelpText>
            </Stat>

            <Stat variant="danger">
              <StatLabel>Clicked</StatLabel>
              <StatNumber>45</StatNumber>
              <StatHelpText>
                <StatArrow type='decrease' />
                9.05%
              </StatHelpText>
            </Stat>
        </StatGroup>

      <IconButton
        aria-label="toggle theme"
        rounded="full"
        size="xs"
        position="absolute"
        bottom={4}
        left={4}
        onClick={toggleColorMode} icon={colorMode === "dark" ? <FaSun /> : <FaMoon />}
      />
    </Box>
  );
}

Open Sandbox

Edit this page on GitHub