Skip to content

The open alternative to Salesforce, designed for AI.

3.0 KB
Raw Blame
{/*
 * _____                    _
 *|_   _|_      _____ _ __ | |_ _   _
 *  | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
 *  | |  \ V  V /  __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
 *  |_|   \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
 *                              |___/
 *
 * This file is generated from the documentation data in packages/twenty-ui/generated.
 * To update it, edit the component prop types or design tokens in twenty-ui and run:
 *   npx nx generate:ui twenty-docs
 */}

<ParamField body="aria-label" type="string">
  Accessible name identifying the measured operation.
</ParamField>

<ParamField body="aria-labelledby" type="string">
  ID of the visible label that names the operation.
</ParamField>

<ParamField body="aria-valuetext" type="string">
  Human-readable progress value overriding the default formatted value.
</ParamField>

<ParamField body="barColor" type="string">
  CSS color of the filled arc. Defaults to the blue theme color.
</ParamField>

<ParamField body="children" type="ReactNode">
  Optional preformatted value or Progress parts displayed before the ring.
</ParamField>

<ParamField body="className" type="string | ((state: ProgressRootState) =&gt; string | undefined)">
  Class applied to the progress root, or a callback receiving its status.
</ParamField>

<ParamField body="format" type="NumberFormatOptions">
  Intl.NumberFormat options for the clamped numeric value. The default displays the normalized percentage.
</ParamField>

<ParamField body="getAriaValueText" type="((formattedValue: string, value: number | null) =&gt; string)">
  Receives the formatted value and raw value, including null, and returns an accessible value description.
</ParamField>

<ParamField body="locale" type="LocalesArgument">
  Locale or locale list used to format the value. Defaults to the runtime locale.
</ParamField>

<ParamField body="max" type="number" default="100">
  Inclusive maximum. Defaults to 100.
</ParamField>

<ParamField body="min" type="number" default="0">
  Inclusive minimum. Defaults to 0.
</ParamField>

<ParamField body="ref" type="Ref&lt;HTMLDivElement&gt;">
  Ref to the root div, or the element composed through render.
</ParamField>

<ParamField body="render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, ProgressRootState&gt;">
  Composes the root with an element or render callback. Forward the supplied props and ref to retain progress semantics.
</ParamField>

<ParamField body="size" type="&quot;md&quot; | &quot;sm&quot;" default="md">
  Ring diameter: sm (14px) or md (16px). Defaults to md.
</ParamField>

<ParamField body="style" type="CSSProperties | ((state: ProgressRootState) =&gt; CSSProperties | undefined)">
  Inline styles applied to the progress root, or a callback receiving its status.
</ParamField>

<ParamField body="value" type="number | null" required>
  Controlled value in the min/max range. Use null for indeterminate progress.
</ParamField>