ngx-spinner.component.d.ts 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. import { OnDestroy, OnInit, OnChanges, SimpleChange, ChangeDetectorRef } from '@angular/core';
  2. import { NgxSpinnerService } from './ngx-spinner.service';
  3. import { Subject } from 'rxjs';
  4. import { Size, NgxSpinner } from './ngx-spinner.enum';
  5. export declare class NgxSpinnerComponent implements OnDestroy, OnInit, OnChanges {
  6. private spinnerService;
  7. private changeDetector;
  8. /**
  9. * To set backdrop color
  10. * Only supports RGBA color format
  11. * @memberof NgxSpinnerComponent
  12. */
  13. bdColor: string;
  14. /**
  15. * To set spinner size
  16. *
  17. * @memberof NgxSpinnerComponent
  18. */
  19. size: Size;
  20. /**
  21. * To set spinner color(DEFAULTS.SPINNER_COLOR)
  22. *
  23. * @memberof NgxSpinnerComponent
  24. */
  25. color: string;
  26. /**
  27. * To set type of spinner
  28. *
  29. * @memberof NgxSpinnerComponent
  30. */
  31. type: string;
  32. /**
  33. * To toggle fullscreen mode
  34. *
  35. * @memberof NgxSpinnerComponent
  36. */
  37. fullScreen: boolean;
  38. /**
  39. * Spinner name
  40. *
  41. * @memberof NgxSpinnerComponent
  42. */
  43. name: string;
  44. /**
  45. * z-index value
  46. *
  47. * @memberof NgxSpinnerComponent
  48. */
  49. zIndex: number;
  50. /**
  51. * Spinner Object
  52. *
  53. * @memberof NgxSpinnerComponent
  54. */
  55. spinner: NgxSpinner;
  56. /**
  57. * Array for spinner's divs
  58. *
  59. * @memberof NgxSpinnerComponent
  60. */
  61. divArray: Array<number>;
  62. /**
  63. * Counter for div
  64. *
  65. * @memberof NgxSpinnerComponent
  66. *
  67. */
  68. divCount: number;
  69. /**
  70. * Show spinner
  71. *
  72. * @memberof NgxSpinnerComponent
  73. **/
  74. show: boolean;
  75. /**
  76. * Unsubscribe from spinner's observable
  77. *
  78. * @memberof NgxSpinnerComponent
  79. **/
  80. ngUnsubscribe: Subject<void>;
  81. /**
  82. * Creates an instance of NgxSpinnerComponent.
  83. *
  84. * @memberof NgxSpinnerComponent
  85. */
  86. constructor(spinnerService: NgxSpinnerService, changeDetector: ChangeDetectorRef);
  87. /**
  88. * Initialization method
  89. *
  90. * @memberof NgxSpinnerComponent
  91. */
  92. ngOnInit(): void;
  93. /**
  94. * To set default ngx-spinner options
  95. *
  96. * @memberof NgxSpinnerComponent
  97. */
  98. setDefaultOptions: () => void;
  99. /**
  100. * On changes event for input variables
  101. *
  102. * @memberof NgxSpinnerComponent
  103. */
  104. ngOnChanges(changes: {
  105. [propKey: string]: SimpleChange;
  106. }): void;
  107. /**
  108. * To get class for spinner
  109. *
  110. * @memberof NgxSpinnerComponent
  111. */
  112. getClass(type: string, size: Size): string;
  113. /**
  114. * Check if input variables have changed
  115. *
  116. * @memberof NgxSpinnerComponent
  117. */
  118. onInputChange(): void;
  119. /**
  120. * Component destroy event
  121. *
  122. * @memberof NgxSpinnerComponent
  123. */
  124. ngOnDestroy(): void;
  125. }