toast.d.ts 1.5KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. import { App } from '../app/app';
  2. import { Config } from '../../config/config';
  3. import { NavOptions } from '../../navigation/nav-util';
  4. import { ToastOptions } from './toast-options';
  5. import { ViewController } from '../../navigation/view-controller';
  6. /**
  7. * @hidden
  8. */
  9. export declare class Toast extends ViewController {
  10. private _app;
  11. constructor(app: App, opts: ToastOptions, config: Config);
  12. /**
  13. * @hidden
  14. */
  15. getTransitionName(direction: string): string;
  16. /**
  17. * @hidden
  18. */
  19. isValidPosition(position: string): boolean;
  20. /**
  21. * @param {string} message Toast message content
  22. */
  23. setMessage(message: string): Toast;
  24. /**
  25. * @param {number} dur Toast message duration
  26. */
  27. setDuration(dur: number): Toast;
  28. /**
  29. * @param {'top'|'middle'|'bottom'} pos Toast message position
  30. */
  31. setPosition(pos: 'top' | 'middle' | 'bottom'): Toast;
  32. /**
  33. * @param {string} cssClass Toast message CSS class
  34. */
  35. setCssClass(cssClass: string): Toast;
  36. /**
  37. * @param {boolean} closeButton Toast message close button
  38. */
  39. setShowCloseButton(closeButton: boolean): Toast;
  40. /**
  41. * Present the toast instance.
  42. *
  43. * @param {NavOptions} [navOptions={}] Nav options to go with this transition.
  44. * @returns {Promise} Returns a promise which is resolved when the transition has completed.
  45. */
  46. present(navOptions?: NavOptions): Promise<any>;
  47. /**
  48. * Dismiss all toast components which have been presented.
  49. */
  50. dismissAll(): void;
  51. }