@octopusdeploy/design-system-components
Version:
The design systems component library.
47 lines (46 loc) • 1.79 kB
TypeScript
/** Props used for the {@link IndeterminateLinearProgress} component */
export interface IndeterminateLinearProgressVariantProps {
/**
* The visibility of the component.
*
* When this is false, the progress bar is hidden and replaced with an empty space of the same size.
* This is to prevent the layout shifting as a result of showing or hiding the progress bar.
*/
show: boolean;
/**
* The linear progress variant.
*
* The indeterminate progress variant should be used when an action's overall completion can not be determined
* such as loading data in the background.
*/
variant: "indeterminate";
}
/** Props used for the {@link DeterminateLinearProgress} component */
export interface DeterminateLinearProgressVariantProps extends DeterminateLinearProgressProps {
/**
* The visibility of the component.
*
* When this is false, the progress bar is hidden and replaced with an empty space of the same size.
* This is to prevent the layout shifting as a result of showing or hiding the progress bar.
*/
show: boolean;
/**
* The linear progress variant.
*
* The determinate progress variant should be used when an action's overall completion can be determined.
*/
variant: "determinate";
}
/** Props used for the {@link LinearProgress} component */
export type LinearProgressProps = IndeterminateLinearProgressVariantProps | DeterminateLinearProgressVariantProps;
/**
* <LinearProgress show={true} />
* ```
*/
export declare function LinearProgress(props: LinearProgressProps): import("react/jsx-runtime").JSX.Element;
export declare namespace LinearProgress {
var displayName: string;
}
export interface DeterminateLinearProgressProps {
value: number;
}