@intility/bifrost-react
Version:
React library for Intility's design system, Bifrost.
27 lines (26 loc) • 1.11 kB
TypeScript
import React from "react";
import type { PropsFor } from "../../types.js";
export type ProgressBarSize = ProgressBarProps["size"];
export type ProgressBarProps = PropsFor<"div", {
/** Current progress as number (0-100) (unless max is specified) */
value: number;
/** Maximum value (default 100, which will be displayed as percentage) */
max?: number;
/** Available sizes: 'large', 'medium' (default), and 'small' */
size?: "large" | "medium" | "small";
/** Hide percentage label, will add label prop as aria-label for screen readers */
hideLabel?: boolean;
/** Disable the control */
disabled?: boolean;
/** Available states: `"default"`, `"success"`, `"warning"`, and `"alert"` */
state?: "default" | "success" | "warning" | "alert";
/** Animated barbershop-style loading stripes */
loading?: boolean;
}>;
/**
* Display progress as percentage
*
* @see https://bifrost.intility.com/react/progressBar
*/
declare const ProgressBar: React.ForwardRefExoticComponent<ProgressBarProps & React.RefAttributes<HTMLDivElement>>;
export default ProgressBar;