| Prop | Default | Type |
|---|---|---|
as | 'div' | AsTag | ComponentThe element or component this component should render as. Can be overwritten by |
asChild | booleanChange the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details. | |
getValueLabel | isNumber(value) ? `${Math.round((value / max) * DEFAULT_MAX)}%` : undefined | ((value: number | null, max: number) => string)A function to get the accessible label text in a human-readable format. If not provided, the value label will be read as the numeric value as a percentage of the max value. |
getValueText | ((value: number | null, max: number) => string)A function to get the accessible value text representing the current value in a human-readable format. | |
max | DEFAULT_MAX | numberThe maximum progress value. |
modelValue | number | nullThe progress value. Can be bind as |
| Emit | Payload |
|---|---|
update:max | [value: number]Event handler called when the max value changes |
update:modelValue | [value: string[]]Event handler called when the progress value changes |
| Slots (default) | Payload |
|---|---|
modelValue | number | null | undefinedCurrent input values |
| Methods | Type |
|---|---|
getValueLabel | (value: number | null | undefined, max: number) => string | undefinedA function to get the accessible label text in a human-readable format. If not provided, the value label will be read as the numeric value as a percentage of the max value. |
