XiodUI
HomeDocs
OverviewComponentsStyling & CustomizationChangelog

Components

  • Accordion
  • Agent Steps
  • Alert
  • Alert Dialog
  • Aspect Ratio
  • Autocomplete
  • Avatar
  • Badge
  • Breadcrumb
  • Button
  • Button Group
  • Button Split
  • Calendar
  • Card
  • Carousel
  • Checkbox
  • Circular Progress
  • Collapsible
  • Color Picker
  • Combobox
  • Command
  • Context Menu
  • Copy To Clipboard
  • Corner Badge
  • Dashboard Grid
  • Date Picker
  • Dialog
  • Dot Matrix
  • Draggable
    Updated
  • Drawer
  • Empty
  • Field
  • Fieldset
  • File Upload
    Updated
  • Form
  • Frame
  • Gauge
  • Grid
  • Group
  • Input
  • Input Group
  • Input OTP
  • Input Payment
  • Input Phone
    Updated
  • Input Sensitive
  • Kbd
  • Kinetic Click
  • Label
  • List Box
    Updated
  • Loader
  • Marker
  • Menu
  • Menubar
  • Message
  • Meter
  • Morphic Toast
  • Navigation Menu
  • Number Field
  • Option Picker
  • Orb
  • Pagination
  • Popover
  • Preview Card
    Updated
  • Progress
  • Radio
  • Resizable
  • Ruler Picker
  • Scroll Area
  • Scroll Bar
  • Select
  • Separator
  • Sidebar
  • Skeleton
  • Slider
  • Sortable
  • Switch
  • Table
  • Tabs
  • Text
  • Textarea
  • Timeline
  • Toast
  • Toggle
  • Toggle Group
  • Toolbar
  • Tooltip
  • Waveform
  • Wheel Picker

Loading...

Preview Skeleton

Installation Skeleton

Usage Skeleton

API Reference Skeleton

Sponsors

Support the development of XiodUI and help us build the best component library on Earth.

+++
Sponsor on GitHub

Circular Progress

Previous: CheckboxNext: Collapsible

A ring that shows progress toward completion, or spins while the duration is unknown.

Preview

Loading Preview...

Installation

bun add xiod-ui

Usage

Imports

1import { CircularProgress } from "xiod-ui/circular-progress";

API Reference

Detailed documentation of properties and options.

CircularProgress

Accepts render, plus every native <div> attribute.

PropTypeDefaultDescription
format
((value: number) => string)
–

Formats the value for screen readers and for showValue, such as (v) => ${v} of 12 files``. Without it the value reads as a percentage.

labels
Partial<CircularProgressLabels>
CheckboxCollapsible
–

Replaces the built-in text for this instance. See LabelsProvider to change it everywhere.

max
number
100

The highest value. A max at or below min falls back to min + 100.

min
number
0

The lowest value.

showValue
boolean
false

Whether the formatted value is shown in the centre while the value is known. Ignored when children is set.

size
number|"lg"|"sm"|"default"|"2xl"|"xl"
"default"

The size of the circular progress indicator. Can be a string identifier ("sm" to "2xl") or explicit pixel dimensions.

strokeWidth
number
–

The stroke width of the SVG circle.

value
number|null
–

The progress value, from min to max. null or undefined shows an indeterminate spinner.

variant
"default"|"expressive"
"default"

Defines standard rendering or wavy geometries wrapping the progress stroke.