ProgressBar.d.ts 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. import React from 'react';
  2. import { TypeOptions, ToastClassName, Theme } from '../types';
  3. export interface ProgressBarProps {
  4. /**
  5. * The animation delay which determine when to close the toast
  6. */
  7. delay: number;
  8. /**
  9. * Whether or not the animation is running or paused
  10. */
  11. isRunning: boolean;
  12. /**
  13. * Func to close the current toast
  14. */
  15. closeToast: () => void;
  16. /**
  17. * Optional type : info, success ...
  18. */
  19. type?: TypeOptions;
  20. /**
  21. * The theme that is currently used
  22. */
  23. theme: Theme;
  24. /**
  25. * Hide or not the progress bar
  26. */
  27. hide?: boolean;
  28. /**
  29. * Optionnal className
  30. */
  31. className?: ToastClassName;
  32. /**
  33. * Optionnal inline style
  34. */
  35. style?: React.CSSProperties;
  36. /**
  37. * Tell wether or not controlled progress bar is used
  38. */
  39. controlledProgress?: boolean;
  40. /**
  41. * Controlled progress value
  42. */
  43. progress?: number | string;
  44. /**
  45. * Support rtl content
  46. */
  47. rtl?: boolean;
  48. /**
  49. * Tell if the component is visible on screen or not
  50. */
  51. isIn?: boolean;
  52. }
  53. export declare function ProgressBar({ delay, isRunning, closeToast, type, hide, className, style: userStyle, controlledProgress, progress, rtl, isIn, theme }: ProgressBarProps): React.JSX.Element;