native-base
Version:
Essential cross-platform UI components for React Native
78 lines (77 loc) • 2.27 kB
TypeScript
import type { MutableRefObject } from 'react';
import type { InterfaceBoxProps } from '../../primitives/Box';
import type { IStackProps } from '../../primitives/Stack/Stack';
import type { CustomProps, ResponsiveValue } from '../../../components/types';
import type { ISizes } from '../../../theme/base/sizes';
import type { IColors } from '../../../theme/base/colors';
export interface InterfaceSkeletonProps extends InterfaceBoxProps<ISkeletonProps> {
/**
* The fadeIn duration in seconds
*/
fadeDuration?: number;
/**
* If true, it will render its children
*/
isLoaded?: boolean;
/**
* The animation speed in seconds
*/
speed?: number;
/**
* The color at the animation start
*/
startColor?: ResponsiveValue<IColors | (string & {})>;
/**
* The color at the animation end
*/
endColor?: ResponsiveValue<IColors | (string & {})>;
/**
* Sizes for Skeleton
*/
size?: ResponsiveValue<ISizes | (string & {}) | number>;
}
export interface ISkeletonTextProps extends IStackProps {
/**
* The fadeIn duration in seconds
*/
fadeDuration?: number;
/**
* If true, it will render its children
*/
isLoaded?: boolean;
/**
* The animation speed in seconds
*/
speed?: number;
/**
* The color at the animation start
*/
startColor?: ResponsiveValue<IColors | (string & {})>;
/**
* The color at the animation end
*/
endColor?: ResponsiveValue<IColors | (string & {})>;
/**
* Number of Lines in text
*/
lines?: number;
/**
* Stying for each line
*/
_line?: Partial<ISkeletonProps>;
/**
* Props to be passed to the Stack used inside.
*/
_stack?: Partial<IStackProps>;
}
export declare type ISkeletonComponentType = ((props: ISkeletonProps & {
ref?: MutableRefObject<any>;
}) => JSX.Element) & {
Circle: React.MemoExoticComponent<(props: ISkeletonProps & {
ref?: MutableRefObject<any>;
}) => JSX.Element>;
Text: React.MemoExoticComponent<(props: ISkeletonTextProps & {
ref?: MutableRefObject<any>;
}) => JSX.Element>;
};
export declare type ISkeletonProps = InterfaceSkeletonProps & CustomProps<'Skeleton'>;