Repository URL to install this package:
|
Version:
4.0.35 ▾
|
import { ReactNode } from 'react';
import { CommonState } from 'src/state';
/**
* Render Prop
*/
export interface BlinkRenderProp extends Function {
(props: BlinkProps, state?: CommonState): ReactNode;
}
/**
* Props
*/
export interface BlinkProps {
/**
* ClassName of the component
*/
className?: string;
/**
* The Text that is displayed
*/
children?: ReactNode;
content?: string;
/**
* Time interval for blinking
*/
duration?: number;
/**
* @note - this is not really a prop? this is a state property...
* @note - commonState says this would be `isActive`?
* To represent blinking as true/false
*/
shouldBlink?: boolean;
/**
* Common state for blinking
*/
state?: CommonState;
renderChildren?: BlinkRenderProp;
renderWrapper?: BlinkRenderProp;
onClick?: (event?: Event) => void;
}