ProgressCircular

Feedback & Status
stable

SVG-based circular progress indicator. Supports determinate, indeterminate and custom size modes.

Aperçu

Rendu de l’aperçu en cours…

indeterminate

Rendu de l’aperçu en cours…

25%

Rendu de l’aperçu en cours…

50%

Rendu de l’aperçu en cours…

75%

Rendu de l’aperçu en cours…

100%

Structure

Anatomie

Décomposition visuelle de la structure interne du composant avec les appels de classes BEM.

Anatomy of OrigamProgressCircularSchematic of the ProgressCircular component with 4 numbered internal parts. 60% 1 2 3 4 ① root (div.origam-progress--circular) ② svg > circle.origam-progress__underlay ③ svg > circle.origam-progress__overlay ④ div.origam-progress__content (#default slot)
Anatomy of <origam-progress-circular> — 4 internal parts: root container ①, background SVG ring ②, foreground SVG arc ③, and content slot for inner label ④.
1.origam-progress--circular
Root element. display: inline-flex; position: relative. Size driven by size prop via useSize → origam-progress--size-{size} modifier.
2.origam-progress__underlay
Background SVG circle (<circle>). Color from bgColor prop. Opacity 0.5 by default. z-index: 1.
3.origam-progress__overlay
Foreground SVG arc. stroke-dashoffset driven by normalised value. In indeterminate mode: animated via CSS keyframes. z-index: 2.
4.origam-progress__content
Center content area. Rendered only when the #default slot is filled. display: flex; align-items: center; justify-content: center.

API

Props

Toutes les props acceptées par ce composant, avec leur type, valeur par défaut et description.

rotate
string | number
0
Rotation offset applied to the SVG. The start point defaults to the top (−90 deg applied internally).
indeterminate
boolean
false
Activates the continuous spin animation (unknown duration). Overrides modelValue display.
modelValue
string | number
0
Current progress value between 0 and max. Ignored in indeterminate mode.
thickness
string | number
4
Stroke width of the SVG circles. Accepts a number (px) or CSS length.
active
boolean
true
When false, the component is hidden (visibility: hidden).
absolute
boolean
false
Positions the component absolutely within its container.
max
number | string
100
Maximum value used to normalise modelValue into a 0-100 percentage.
striped
boolean
false
Adds a stripe pattern to the progress arc.
label
string
'Loading'
Accessible label (aria-label) for the progress indicator. Pass a localised string.
tag
string
'div'
Root HTML element.
id
string
class
string | Array<string> | object
style
string | Array<string> | object | StyleValue
color
Foreground arc color. Accepts intent tokens (primary, success…) or a CSS color.
bgColor
Background ring color. Defaults to --origam-progress-circular__underlay---color (color.surface.disabled at 50% opacity).
padding
boolean | number | string
paddingTop
boolean | number | string
paddingLeft
boolean | number | string
paddingBottom
boolean | number | string
paddingRight
boolean | number | string
paddingBlock
boolean | number | string
paddingInline
boolean | number | string
paddingInlineStart
boolean | number | string
paddingInlineEnd
boolean | number | string
paddingBlockStart
boolean | number | string
paddingBlockEnd
boolean | number | string
margin
boolean | number | string
marginTop
boolean | number | string
marginLeft
boolean | number | string
marginBottom
boolean | number | string
marginRight
boolean | number | string
marginBlock
boolean | number | string
marginInline
boolean | number | string
marginInlineStart
boolean | number | string
marginInlineEnd
boolean | number | string
marginBlockStart
boolean | number | string
marginBlockEnd
boolean | number | string
size
'default'
Controls the component dimensions. Named sizes: x-small (16), small (24), default (32), large (48), x-large (64). A number sets an explicit pixel size.

API

Slots

Emplacements de contenu exposés par ce composant.

#default
Content rendered inside the circular progress (e.g. a percentage label). Slot prop value is the normalised 0-100 value.

API

Membres exposés

Propriétés et méthodes accessibles via ref template (defineExpose). Utilisés pour le contrôle programmatique.

<T extends object>(props: T, exclude?: string[]) => Partial<T>
Utility to forward a filtered subset of props to child components.
Ref<string>
Reactive CSS string generated by useStyle.
string
Unique style-sheet ID for this instance.
() => void
Injects the computed style sheet into the document.
() => void
Removes the injected style sheet.
Ref<boolean>
True once the style sheet has been injected.

Personnalisation

Variables CSS

Propriétés CSS personnalisées exposées par ce composant. Surchargez-les pour personnaliser sans perdre la compatibilité avec le thème.

Color of the background ring. Resolves to neutral.200 (light) / neutral.800 (dark).
Opacity of the background ring.
Foreground arc color. Overridden at runtime by the color prop via useTextColor.
Duration of the stroke-dashoffset transition in determinate mode.
Easing function for the stroke transition.

Inclusion

Accessibilité

Rôles ARIA, navigation clavier et gestion du focus. Sourcé depuis le template réel du composant.

Rôles ARIA

progressbar

Notes

  • The component applies role="progressbar" via the progress composable. aria-valuenow, aria-valuemin (0) and aria-valuemax are bound automatically.
  • Pass the label prop with a localised string to set aria-label. Defaults to "Loading".
  • Under prefers-reduced-motion: reduce, the CSS spin and dash animations are disabled.

Fondation

Design tokens

Extrait des tokens de ce composant — les variables --origam-<composant>---<propriété>, déclarées dans sa feuille de tokens tenue à la main, sans étape de build.

Source
dimension
32px
Default (medium) size: 32 × 32 px.
color
var(--origam-color__surface---disabled)
Background ring color — muted track.
number
var(--origam-opacity---50)
Background ring opacity.
color
var(--origam-color__action--primary---bg)
Default foreground arc color (overridden by color prop at runtime).
duration
var(--origam-motion__duration---medium)
Arc transition duration in determinate mode.
duration
1400ms
Duration of the indeterminate spin/dash SVG animations.

Interactif

Playground

Modifiez les props en direct et observez le composant se mettre à jour. Le snippet de code généré suit vos changements.

Rendu de l’aperçu en cours…

Usage

Exemples

Extraits de code prêts à coller dans vos templates.

Determinate

vue

Indeterminate

vue

Sizes

vue

Écosystème

Famille

Composants du même dossier qui partagent les conventions et se composent souvent ensemble.