Skip to content

The open alternative to Salesforce, designed for AI.

1.9 KB
Raw Blame
import { type ComponentProps } from 'react';

import { type ProgressBar } from '../src/primitives/feedback/ProgressBar/ProgressBar';

export const PROGRESS_BAR_PROP_DESCRIPTIONS = {
  value:
    'Controlled value in the min/max range. Use null for indeterminate progress.',
  min: 'Inclusive minimum. Defaults to 0.',
  max: 'Inclusive maximum. Defaults to 100.',
  size: 'Bar height: sm (6px) or md (8px).',
  barColor: 'CSS color of the filled bar. Defaults to the primary text color.',
  backgroundColor: 'CSS background color of the track.',
  withBorderRadius: 'Rounds the track and indicator corners.',
  withMinimumFillWidth:
    'Applies a cosmetic minimum of up to 12px, capped at half the track width, only above the minimum and below completion.',
  children: 'Additional Progress parts or supporting content inside the root.',
  'aria-label': 'Accessible name identifying the measured operation.',
  'aria-labelledby': 'ID of the visible label that names the operation.',
  'aria-valuetext':
    'Human-readable progress value overriding the default formatted value.',
  format:
    'Intl.NumberFormat options for the clamped numeric value. The default displays the normalized percentage.',
  locale:
    'Locale or locale list used to format the value. Defaults to the runtime locale.',
  getAriaValueText:
    'Receives the formatted value and raw value, including null, and returns an accessible value description.',
  className:
    'Class applied to the progress root, or a callback receiving its status.',
  style:
    'Inline styles applied to the progress root, or a callback receiving its status.',
  ref: 'Ref to the root div, or the element composed through render.',
  render:
    'Composes the root with an element or render callback. Forward the supplied props and ref to retain progress semantics.',
} satisfies Partial<Record<keyof ComponentProps<typeof ProgressBar>, string>>;