UNPKG

@atlaskit/progress-bar

Version:

A progress bar communicates the status of a system process.

96 lines (74 loc) 1.91 kB
<!-- API Report Version: 2.3 --> ## API Report File for "@atlaskit/progress-bar" > Do not edit this file. This report is auto-generated using > [API Extractor](https://api-extractor.com/). > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports) ### Table of contents - [Main Entry Types](#main-entry-types) - [Peer Dependencies](#peer-dependencies) ### Main Entry Types <!--SECTION START: Main Entry Types--> ```ts /// <reference types="react" /> import { jsx } from '@emotion/react'; import { ThemeProp } from '@atlaskit/theme/components'; // @public (undocumented) interface CustomProgressBarProps { ariaLabel?: string; isIndeterminate?: boolean; testId?: string; value?: number; } // @public (undocumented) interface DefaultProgressBarProps extends CustomProgressBarProps { appearance?: 'default' | 'inverse' | 'success'; // @deprecated (undocumented) theme?: ThemeProp<ThemeTokens, ThemeProps>; } // @public const ProgressBar: ({ appearance, ariaLabel, isIndeterminate, testId, theme, value, }: DefaultProgressBarProps) => jsx.JSX.Element; export default ProgressBar; // @public export const SuccessProgressBar: ({ ariaLabel, isIndeterminate, testId, value, }: CustomProgressBarProps) => JSX.Element; // @public @deprecated (undocumented) type ThemeProps = { value: number | string; }; // @public @deprecated (undocumented) type ThemeTokens = { container: any; bar: any; determinateBar: any; increasingBar: any; decreasingBar: any; }; // @public export const TransparentProgressBar: ({ ariaLabel, isIndeterminate, testId, value, }: CustomProgressBarProps) => JSX.Element; // (No @packageDocumentation comment for this package) ``` <!--SECTION END: Main Entry Types--> ### Peer Dependencies <!--SECTION START: Peer Dependencies--> ```json { "react": "^16.8.0" } ``` <!--SECTION END: Peer Dependencies-->