UNPKG

1.36 kBTypeScriptView Raw
1import * as React from 'react';
2import { StyleProp, View, ViewStyle } from 'react-native';
3import type { ThemeProp } from '../types';
4export declare type Props = React.ComponentPropsWithRef<typeof View> & {
5 /**
6 * Whether to show the indicator or hide it.
7 */
8 animating?: boolean;
9 /**
10 * The color of the spinner.
11 */
12 color?: string;
13 /**
14 * Size of the indicator.
15 */
16 size?: 'small' | 'large' | number;
17 /**
18 * Whether the indicator should hide when not animating.
19 */
20 hidesWhenStopped?: boolean;
21 style?: StyleProp<ViewStyle>;
22 /**
23 * @optional
24 */
25 theme?: ThemeProp;
26};
27/**
28 * Activity indicator is used to present progress of some activity in the app.
29 * It can be used as a drop-in for the ActivityIndicator shipped with React Native.
30 *
31 * ## Usage
32 * ```js
33 * import * as React from 'react';
34 * import { ActivityIndicator, MD2Colors } from 'react-native-paper';
35 *
36 * const MyComponent = () => (
37 * <ActivityIndicator animating={true} color={MD2Colors.red800} />
38 * );
39 *
40 * export default MyComponent;
41 * ```
42 */
43declare const ActivityIndicator: ({ animating, color: indicatorColor, hidesWhenStopped, size: indicatorSize, style, theme: themeOverrides, ...rest }: Props) => React.JSX.Element;
44export default ActivityIndicator;
45//# sourceMappingURL=ActivityIndicator.d.ts.map
\No newline at end of file