@carbon/react
Version:
React components for the Carbon Design System
88 lines (87 loc) • 2.31 kB
TypeScript
/**
* Copyright IBM Corp. 2021
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import PropTypes from 'prop-types';
export interface ProgressBarProps {
/**
* Additional CSS class names.
*/
className?: string;
/**
* The current progress as a textual representation.
*/
helperText?: string;
/**
* Whether the label should be visually hidden.
*/
hideLabel?: boolean;
/**
* A label describing the progress bar.
*/
label: string;
/**
* The maximum value.
*/
max?: number;
/**
* Specify the size of the progress bar.
*/
size?: 'small' | 'big';
/**
* Specify the status.
*/
status?: 'active' | 'finished' | 'error';
/**
* Defines the alignment variant of the progress bar.
*/
type?: 'default' | 'inline' | 'indented';
/**
* The current value.
*/
value?: number;
}
declare function ProgressBar({ className, helperText, hideLabel, label, max, size, status, type, value, }: ProgressBarProps): import("react/jsx-runtime").JSX.Element;
declare namespace ProgressBar {
var propTypes: {
/**
* Additional CSS class names.
*/
className: PropTypes.Requireable<string>;
/**
* The current progress as a textual representation.
*/
helperText: PropTypes.Requireable<string>;
/**
* Whether the label should be visually hidden.
*/
hideLabel: PropTypes.Requireable<boolean>;
/**
* A label describing the progress bar.
*/
label: PropTypes.Validator<string>;
/**
* The maximum value.
*/
max: PropTypes.Requireable<number>;
/**
* Specify the size of the ProgressBar.
*/
size: PropTypes.Requireable<string>;
/**
* Specify the status.
*/
status: PropTypes.Requireable<string>;
/**
* Defines the alignment variant of the progress bar.
*/
type: PropTypes.Requireable<string>;
/**
* The current value.
*/
value: PropTypes.Requireable<number>;
};
}
export default ProgressBar;