The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
{/*
* _____ _
*|_ _|_ _____ _ __ | |_ _ _
* | | \ \ /\ / / _ \ '_ \| __| | | | 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
*/}
### Progress.Root
<ParamField body="Root.aria-label" type="string">
Accessible name identifying the measured operation.
</ParamField>
<ParamField body="Root.aria-labelledby" type="string">
ID of the visible label that names the operation.
</ParamField>
<ParamField body="Root.aria-valuetext" type="string">
Human-readable progress value overriding the default formatted value.
</ParamField>
<ParamField body="Root.children" type="ReactNode">
Composed Progress parts and supporting content.
</ParamField>
<ParamField body="Root.className" type="string | ((state: ProgressRootState) => string | undefined)">
Class applied to this part, or a callback receiving its progress status.
</ParamField>
<ParamField body="Root.format" type="NumberFormatOptions">
Intl.NumberFormat options for the clamped numeric value. The default displays the normalized percentage.
</ParamField>
<ParamField body="Root.getAriaValueText" type="((formattedValue: string, value: number | null) => string)">
Receives the formatted value and raw value, including null, and returns an accessible value description.
</ParamField>
<ParamField body="Root.locale" type="LocalesArgument">
Locale or locale list used to format the value. Defaults to the runtime locale.
</ParamField>
<ParamField body="Root.max" type="number" default="100">
Inclusive maximum. Defaults to 100.
</ParamField>
<ParamField body="Root.min" type="number" default="0">
Inclusive minimum. Defaults to 0.
</ParamField>
<ParamField body="Root.ref" type="Ref<HTMLDivElement>">
Ref to the root div, or the element composed through Root.render.
</ParamField>
<ParamField body="Root.render" type="ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ProgressRootState>">
Composes this part with an element or render callback. Forward the supplied props and ref to the corresponding DOM element.
</ParamField>
<ParamField body="Root.style" type="CSSProperties | ((state: ProgressRootState) => CSSProperties | undefined)">
Inline styles applied to this part, or a callback receiving its progress status.
</ParamField>
<ParamField body="Root.value" type="number | null" required>
Controlled value in the min/max range. Use null for indeterminate progress.
</ParamField>
### Progress.Track
<ParamField body="Track.children" type="ReactNode">
The indicator and optional supporting content.
</ParamField>
<ParamField body="Track.className" type="string | ((state: ProgressTrackState) => string | undefined)">
Class applied to this part, or a callback receiving its progress status.
</ParamField>
<ParamField body="Track.ref" type="Ref<HTMLDivElement>">
Ref to the track div, or the element composed through Track.render.
</ParamField>
<ParamField body="Track.render" type="ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ProgressTrackState>">
Composes this part with an element or render callback. Forward the supplied props and ref to the corresponding DOM element.
</ParamField>
<ParamField body="Track.style" type="CSSProperties | ((state: ProgressTrackState) => CSSProperties | undefined)">
Inline styles applied to this part, or a callback receiving its progress status.
</ParamField>
### Progress.Indicator
<ParamField body="Indicator.className" type="string | ((state: ProgressIndicatorState) => string | undefined)">
Class applied to this part, or a callback receiving its progress status.
</ParamField>
<ParamField body="Indicator.ref" type="Ref<HTMLDivElement>">
Ref to the indicator div, or the element composed through Indicator.render.
</ParamField>
<ParamField body="Indicator.render" type="ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ProgressIndicatorState>">
Composes this part with an element or render callback. Forward the supplied props and ref to the corresponding DOM element.
</ParamField>
<ParamField body="Indicator.style" type="CSSProperties | ((state: ProgressIndicatorState) => CSSProperties | undefined)">
Inline styles applied to this part, or a callback receiving its progress status.
</ParamField>
### Progress.Value
<ParamField body="Value.children" type="((formattedValue: string | null, value: number | null) => ReactNode) | null">
Optional callback receiving the formatted value and raw value. Indeterminate progress passes indeterminate as formatted text. Without a callback, indeterminate progress displays no content.
</ParamField>
<ParamField body="Value.className" type="string | ((state: ProgressValueState) => string | undefined)">
Class applied to this part, or a callback receiving its progress status.
</ParamField>
<ParamField body="Value.ref" type="Ref<HTMLSpanElement>">
Ref to the value span, or the element composed through Value.render.
</ParamField>
<ParamField body="Value.render" type="ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ProgressValueState>">
Composes this part with an element or render callback. Forward the supplied props and ref to the corresponding DOM element.
</ParamField>
<ParamField body="Value.style" type="CSSProperties | ((state: ProgressValueState) => CSSProperties | undefined)">
Inline styles applied to this part, or a callback receiving its progress status.
</ParamField>
### Progress.Label
<ParamField body="Label.children" type="ReactNode">
Visible text that supplies the accessible name of the root.
</ParamField>
<ParamField body="Label.className" type="string | ((state: ProgressLabelState) => string | undefined)">
Class applied to this part, or a callback receiving its progress status.
</ParamField>
<ParamField body="Label.ref" type="Ref<HTMLSpanElement>">
Ref to the label span, or the element composed through Label.render.
</ParamField>
<ParamField body="Label.render" type="ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ProgressLabelState>">
Composes this part with an element or render callback. Forward the supplied props and ref to the corresponding DOM element.
</ParamField>
<ParamField body="Label.style" type="CSSProperties | ((state: ProgressLabelState) => CSSProperties | undefined)">
Inline styles applied to this part, or a callback receiving its progress status.
</ParamField>