archive-gh-me/react-native-circular-progress
1
0
Fork 0
mirror of https://github.com/bartgryszko/react-native-circular-progress.git synced 2026-01-18 16:13:10 +00:00
Code Issues Projects Releases Wiki Activity

Add types fix

Browse Source
This commit is contained in:
Konrad Jaglowski 2019-09-12 10:51:24 +02:00
parent c2799049fa
commit 040929637a
1 changed files with 40 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
index.d.ts vendored
View File

@ -1,25 +1,31 @@
declare module 'react-native-circular-progress' {
import * as React from 'react';
import { Animated, Easing, ViewPropTypes } from 'react-native';
import {
Animated,
Easing,
ViewPropTypes,
StyleProp,
ViewStyle
} from 'react-native';
export interface AnimatedCircularProgressProps {
/**
* Width and height of circle
*
*
* @type {number | Animated.Value}
*/
size: number | Animated.Value;
/**
* Thickness of the progress line
*
*
* @type {number}
*/
width: number;
/**
* Thickness of background circle
*
*
* @type {number}
* @default width
*/
@ -27,7 +33,7 @@ declare module 'react-native-circular-progress' {
/**
* Current progress / fill
*
*
* @type {number}
* @default 0
*/
@ -35,7 +41,7 @@ declare module 'react-native-circular-progress' {
/**
* Color of the progress line
*
*
* @type {string}
* @default 'black'
*/
@ -43,14 +49,14 @@ declare module 'react-native-circular-progress' {
/**
* If unspecified, no background line will be rendered
*
*
* @type {string}
*/
backgroundColor?: string;
/**
* Angle from which the progress starts from
*
*
* @type {number}
* @default 90
*/
@ -58,7 +64,7 @@ declare module 'react-native-circular-progress' {
/**
* Shape used at ends of progress line.
*
*
* @type {('butt' | 'round' | 'square')}
* @default 'butt'
*/
@ -66,7 +72,7 @@ declare module 'react-native-circular-progress' {
/**
* If you don't want a full circle, specify the arc angle
*
*
* @type {number}
* @default 360
*/
@ -74,14 +80,14 @@ declare module 'react-native-circular-progress' {
/**
* Style of the entire progress container
*
*
* @type {ViewPropTypes.style}
*/
style?: ViewPropTypes.style;
style?: StyleProp<ViewStyle>;
/**
* Pass a function as a child. It receiveds the current fill-value as an argument
*
*
* @type {Function}
* @param {number} fill current fill-value
* @return {JSX.Element} the element inside the circle
@ -90,14 +96,14 @@ declare module 'react-native-circular-progress' {
/**
* Style of the children container
*
*
* @type {ViewPropTypes.style}
*/
childrenContainerStyle?: ViewPropTypes.style;
childrenContainerStyle?: StyleProp<ViewStyle>;
/**
* Initial fill-value before animation starts
*
*
* @type {number}
* @default 0
*/
@ -105,14 +111,14 @@ declare module 'react-native-circular-progress' {
/**
* Duration of animation in ms
*
*
* @type {number}
* @default 500
*/
duration?: number;
/**
*
*
* @type {Function}
* @default Easing.out(Easing.ease)
*/
@ -120,29 +126,36 @@ declare module 'react-native-circular-progress' {
/**
* Function that's invoked when the animation completes (both on mount and if called with .animate())
*
*
*/
onAnimationComplete?: () => void
onAnimationComplete?: (event: { finished: boolean }) => void;
}
export class AnimatedCircularProgress extends React.Component<AnimatedCircularProgressProps> {
export class AnimatedCircularProgress extends React.Component<
AnimatedCircularProgressProps
> {
/**
* Animate the progress bar to a specific value
*
* @param {number} toVal
*
* @param {number} toVal
* @param {number} duration
* @param {Function} ease
*/
animate: (toVal: number, duration: number, ease?: Function) => void
animate: (toVal: number, duration: number, ease?: Function) => void;
/**
* Re-run animation with a specified prefill-value
*
*
* @param {number} prefill
* @param {number} toVal
* @param {number} duration
* @param {Function} ease
*/
reAnimate: (prefill: number, toVal: number, duration: number, ease?: Function) => void
reAnimate: (
prefill: number,
toVal: number,
duration: number,
ease?: Function
) => void;
}
}
}