Reference version

This is documentation for the next SDK version. For up-to-date documentation, see the latest version (SDK 54).

CircularProgress

A Jetpack Compose CircularProgress component for displaying circular progress indicators.

Android

Expo UI CircularProgress matches the official Jetpack Compose Progress Indicator API and displays progress in a circular format.

Installation

Terminal
npx expo install @expo/ui

If you are installing this in an existing React Native app, make sure to install expo in your project.

Usage

Indeterminate progress

When no progress is provided, the progress indicator displays an indeterminate spinning animation.

IndeterminateCircularExample.tsx
import { Host, CircularProgress } from '@expo/ui/jetpack-compose'; export default function IndeterminateCircularExample() { return ( <Host matchContents> <CircularProgress /> </Host> ); }

Determinate progress

Provide a progress value between 0 and 1 to show determinate progress.

DeterminateCircularExample.tsx
import { Host, CircularProgress } from '@expo/ui/jetpack-compose'; export default function DeterminateCircularExample() { return ( <Host matchContents> <CircularProgress progress={0.75} /> </Host> ); }

Wavy progress

CircularWavyProgress renders a circular progress indicator with a wavy animation style.

CircularWavyExample.tsx
import { Host, CircularWavyProgress } from '@expo/ui/jetpack-compose'; export default function CircularWavyExample() { return ( <Host matchContents> <CircularWavyProgress progress={0.6} /> </Host> ); }

API

import { CircularProgress, CircularWavyProgress } from '@expo/ui/jetpack-compose';

Components

CircularProgress

Android

Type: React.Element<CircularProgressProps>

Renders a CircularProgress component.

CircularProgressProps

color

Android
Optional • Type: ColorValue

Progress color.

elementColors

Android
Optional • Type: ProgressElementColors

Colors for switch's core elements.

modifiers

Android
Optional • Type: ExpoModifier[]

Modifiers for the component.

progress

Android
Optional • Literal type: union

The current progress value of the slider. This is a number between 0 and 1.

Acceptable values are: number | null

CircularWavyProgress

Android

Type: React.Element<CircularProgressProps>

Renders a CircularWavyProgress component with wavy animation.

LinearProgress

Android

Type: React.Element<LinearProgressProps>

Renders a LinearProgress component.

LinearProgressProps

color

Android
Optional • Type: ColorValue

Progress color.

elementColors

Android
Optional • Type: ProgressElementColors

Colors for switch's core elements.

modifiers

Android
Optional • Type: ExpoModifier[]

Modifiers for the component.

progress

Android
Optional • Literal type: union

The current progress value of the slider. This is a number between 0 and 1.

Acceptable values are: number | null

LinearWavyProgress

Android

Type: React.Element<LinearProgressProps>

Renders a LinearWavyProgress component with wavy animation.

Types

ProgressElementColors

Android
PropertyTypeDescription
trackColor(optional)ColorValue
Only for:
Android

Track color.

Components

CircularProgress

Android

Type: React.Element<CircularProgressProps>

Renders a CircularProgress component.

CircularProgressProps

color

Android
Optional • Type: ColorValue

Progress color.

elementColors

Android
Optional • Type: ProgressElementColors

Colors for switch's core elements.

modifiers

Android
Optional • Type: ExpoModifier[]

Modifiers for the component.

progress

Android
Optional • Literal type: union

The current progress value of the slider. This is a number between 0 and 1.

Acceptable values are: number | null

CircularWavyProgress

Android

Type: React.Element<CircularProgressProps>

Renders a CircularWavyProgress component with wavy animation.

LinearProgress

Android

Type: React.Element<LinearProgressProps>

Renders a LinearProgress component.

LinearProgressProps

color

Android
Optional • Type: ColorValue

Progress color.

elementColors

Android
Optional • Type: ProgressElementColors

Colors for switch's core elements.

modifiers

Android
Optional • Type: ExpoModifier[]

Modifiers for the component.

progress

Android
Optional • Literal type: union

The current progress value of the slider. This is a number between 0 and 1.

Acceptable values are: number | null

LinearWavyProgress

Android

Type: React.Element<LinearProgressProps>

Renders a LinearWavyProgress component with wavy animation.

Types

ProgressElementColors

Android
PropertyTypeDescription
trackColor(optional)ColorValue
Only for:
Android

Track color.