carbon-react
Version:
A library of reusable React components for easily building user interfaces.
33 lines (32 loc) • 1.34 kB
TypeScript
import React from "react";
import { MarginProps } from "styled-system";
import { TagProps } from "../../__internal__/utils/helpers/tags";
export interface ProgressTrackerProps extends MarginProps, TagProps {
/** Size of the progress bar. */
size?: "small" | "medium" | "large";
/** Length of the component, any valid css string. */
length?: string;
/** Current progress (percentage). */
progress?: number;
/** Flag to control error state. */
error?: boolean;
/** Value to add a description to the label */
description?: string;
/** Value to display as current progress. */
currentProgressLabel?: string;
/** Value to display as the maximum progress limit. */
maxProgressLabel?: string;
/** Value of the preposition defined between Value1 and Value2 on the label. */
customValuePreposition?: string;
/**
* The position the value label are rendered in.
*/
labelsPosition?: "top" | "bottom" | "left";
/** Label width when position is "left" */
labelWidth?: string;
}
declare const ProgressTracker: {
({ size, length, error, progress, description, currentProgressLabel, customValuePreposition, maxProgressLabel, labelsPosition, labelWidth, ...rest }: ProgressTrackerProps): React.JSX.Element;
displayName: string;
};
export default ProgressTracker;