Progress

Track task progression across multiple steps, keeping users updated on lengthy processes.

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 Progress component.

size

orientation

<Center className="w-[300px] h-[150px]">
  <Progress value={40} size="md" orientation="horizontal">
    <ProgressFilledTrack />
  </Progress>
</Center>

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add progress

Step 1: Install the following dependencies:

npm i @gluestack-ui/progress

Step 2: Copy and paste the following code into your project.

"use client"
import React from "react"
import { createProgress } from "@gluestack-ui/progress"
import { View } from "react-native"
import { tva } from "@gluestack-ui/nativewind-utils/tva"
import {
  withStyleContext,
  useStyleContext,
} from "@gluestack-ui/nativewind-utils/withStyleContext"
import { cssInterop } from "nativewind"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"

const SCOPE = "PROGRESS"
export const UIProgress = createProgress({
  Root: withStyleContext(View, SCOPE),
  FilledTrack: View,
})

cssInterop(UIProgress, { className: "style" })
cssInterop(UIProgress.FilledTrack, { className: "style" })

const progressStyle = tva({
  base: "bg-background-300 rounded-full w-full",
  variants: {
    orientation: {
      horizontal: "w-full",
      vertical: "h-full",
    },
    size: {
      xs: "h-1",
      sm: "h-2",
      md: "h-3",
      lg: "h-4",
      xl: "h-5",
      "2xl": "h-6",
    },
  },
  compoundVariants: [
    {
      orientation: "vertical",
      size: "xs",
      class: "h-full w-1 justify-end",
    },
    {
      orientation: "vertical",
      size: "sm",
      class: "h-full w-2 justify-end",
    },
    {
      orientation: "vertical",
      size: "md",
      class: "h-full w-3 justify-end",
    },
    {
      orientation: "vertical",
      size: "lg",
      class: "h-full w-4 justify-end",
    },

    {
      orientation: "vertical",
      size: "xl",
      class: "h-full w-5 justify-end",
    },
    {
      orientation: "vertical",
      size: "2xl",
      class: "h-full w-6 justify-end",
    },
  ],
})

const progressFilledTrackStyle = tva({
  base: "bg-primary-500 rounded-full",
  parentVariants: {
    orientation: {
      horizontal: "w-full",
      vertical: "h-full",
    },
    size: {
      xs: "h-1",
      sm: "h-2",
      md: "h-3",
      lg: "h-4",
      xl: "h-5",
      "2xl": "h-6",
    },
  },
  parentCompoundVariants: [
    {
      orientation: "vertical",
      size: "xs",
      class: "h-full w-1",
    },
    {
      orientation: "vertical",
      size: "sm",
      class: "h-full w-2",
    },
    {
      orientation: "vertical",
      size: "md",
      class: "h-full w-3",
    },
    {
      orientation: "vertical",
      size: "lg",
      class: "h-full w-4",
    },

    {
      orientation: "vertical",
      size: "xl",
      class: "h-full w-5",
    },
    {
      orientation: "vertical",
      size: "2xl",
      class: "h-full w-6",
    },
  ],
})

type IProgressProps = VariantProps<typeof progressStyle> &
  React.ComponentProps<typeof UIProgress>
type IProgressFilledTrackProps = VariantProps<typeof progressFilledTrackStyle> &
  React.ComponentProps<typeof UIProgress.FilledTrack>

export const Progress = React.forwardRef<
  React.ElementRef<typeof UIProgress>,
  IProgressProps
>(({ className, size = "md", orientation = "horizontal", ...props }, ref) => {
  return (
    <UIProgress
      ref={ref}
      {...props}
      className={progressStyle({ size, orientation, class: className })}
      context={{ size, orientation }}
      orientation={orientation}
    />
  )
})

export const ProgressFilledTrack = React.forwardRef<
  React.ElementRef<typeof UIProgress.FilledTrack>,
  IProgressFilledTrackProps
>(({ className, ...props }, ref) => {
  const { size: parentSize, orientation: parentOrientation } =
    useStyleContext(SCOPE)

  return (
    <UIProgress.FilledTrack
      ref={ref}
      className={progressFilledTrackStyle({
        parentVariants: {
          size: parentSize,
          orientation: parentOrientation,
        },
        class: className,
      })}
      {...props}
    />
  )
})

Step 3: 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 { Progress, ProgressFilledTrack } from "@/components/ui/progress"

export default () => (
  <Progress>
    <ProgressFilledTrack />
  </Progress>
)

Component Props

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

Progress

It inherits all the properties of React Native's View component.

Prop	Type	Default	Description
value	number	-	It is used to set the progress of the progress bar

ProgressFilledTrack

It also inherits all the properties of React Native's View component.

Accessibility

We have outlined the various features that ensure the Fab component is accessible to all users, including those with disabilities. These features help ensure that your application is inclusive and meets accessibility standards. Adheres to the WAI-ARIA design pattern.

Keyboard

Tab: Moves focus to the next focusable element.

VoiceOver: When the Progress is focused, the screen reader will announce it's a progress and it's current progress indicator.

Props

Progress component is created using View component from react-native. It extends all the props supported by React Native View.

Progress

Name	Value	Default
size	xs \| sm \| md \| lg \| xl \| 2xl	md
orientation	vertical \| horizontal	horizontal

Important Note

Note: These props are exclusively applicable when utilizing the default configuration of gluestack-ui/config. If you are using a custom theme, these props may not be available.

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.

Value

Progress component with value

<VStack space="lg">
  <Text size="lg">Downloading 55%</Text>
  <Progress value={55} className="w-80 h-1">
    <ProgressFilledTrack className="h-1" />
  </Progress>
</VStack>

Color

You can add track color to progress bar as per our needs.

<VStack space="3xl">
  <Progress value={46} className="w-96 h-2" size="sm">
    <ProgressFilledTrack className="bg-emerald-600" />
  </Progress>
  <Progress value={46} className="w-96 h-2" size="sm">
    <ProgressFilledTrack className="bg-amber-600" />
  </Progress>
  <Progress value={46} className="w-96 h-2" size="sm">
    <ProgressFilledTrack className="bg-fuchsia-600" />
  </Progress>
  <Progress value={46} className="w-96 h-2" size="sm">
    <ProgressFilledTrack className="bg-cyan-600" />
  </Progress>
</VStack>

Custom

You can customize the progress bar. Below is the example where we have change the theme of progress bar.

<VStack space="lg">
  <Heading>Internal Storage</Heading>
  <Progress value={46} className="w-[410px] h-2 bg-lime-100">
    <ProgressFilledTrack className="h-2 bg-lime-500" />
  </Progress>
  <Text size="md">14GB</Text>
</VStack>

Progress

Installation

Run the following command:

Step 1: Install the following dependencies:

Step 2: Copy and paste the following code into your project.

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

API Reference

Component Props

Progress

ProgressFilledTrack

Accessibility

Keyboard

Screen Reader

Props

Progress

Examples

Value

Color

Custom