foundation.d.ts 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. /**
  2. * @license
  3. * Copyright 2020 Google Inc.
  4. *
  5. * Permission is hereby granted, free of charge, to any person obtaining a copy
  6. * of this software and associated documentation files (the "Software"), to deal
  7. * in the Software without restriction, including without limitation the rights
  8. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9. * copies of the Software, and to permit persons to whom the Software is
  10. * furnished to do so, subject to the following conditions:
  11. *
  12. * The above copyright notice and this permission notice shall be included in
  13. * all copies or substantial portions of the Software.
  14. *
  15. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21. * THE SOFTWARE.
  22. */
  23. import { MDCFoundation } from '@material/base/foundation';
  24. import { MDCProgressIndicatorFoundation } from '@material/progress-indicator/foundation';
  25. import { MDCCircularProgressAdapter } from './adapter';
  26. /** MDC Circular Progress Foundation */
  27. export declare class MDCCircularProgressFoundation extends MDCFoundation<MDCCircularProgressAdapter> implements MDCProgressIndicatorFoundation {
  28. static get cssClasses(): {
  29. INDETERMINATE_CLASS: string;
  30. CLOSED_CLASS: string;
  31. };
  32. static get strings(): {
  33. ARIA_HIDDEN: string;
  34. ARIA_VALUENOW: string;
  35. DETERMINATE_CIRCLE_SELECTOR: string;
  36. RADIUS: string;
  37. STROKE_DASHOFFSET: string;
  38. };
  39. static get defaultAdapter(): MDCCircularProgressAdapter;
  40. private closed;
  41. private determinate;
  42. private progress;
  43. private radius;
  44. constructor(adapter?: Partial<MDCCircularProgressAdapter>);
  45. init(): void;
  46. /**
  47. * Sets whether the progress indicator is in determinate mode.
  48. * @param determinate Whether the indicator should be determinate.
  49. */
  50. setDeterminate(determinate: boolean): void;
  51. isDeterminate(): boolean;
  52. /**
  53. * Sets the current progress value. In indeterminate mode, this has no
  54. * visual effect but will be reflected if the indicator is switched to
  55. * determinate mode.
  56. * @param value The current progress value, which must be between 0 and 1.
  57. */
  58. setProgress(value: number): void;
  59. getProgress(): number;
  60. /**
  61. * Shows the progress indicator.
  62. */
  63. open(): void;
  64. /**
  65. * Hides the progress indicator
  66. */
  67. close(): void;
  68. /**
  69. * @return Returns whether the progress indicator is hidden.
  70. */
  71. isClosed(): boolean;
  72. }
  73. export default MDCCircularProgressFoundation;