component.d.ts 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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 { MDCComponent } from '@material/base/component';
  24. import { MDCProgressIndicator } from '@material/progress-indicator/component';
  25. import { MDCCircularProgressFoundation } from './foundation';
  26. /** MDC Circular Progress */
  27. export declare class MDCCircularProgress extends MDCComponent<MDCCircularProgressFoundation> implements MDCProgressIndicator {
  28. private determinateCircle;
  29. initialize(): void;
  30. static attachTo(root: HTMLElement): MDCCircularProgress;
  31. /**
  32. * Sets whether the progress indicator is in determinate mode.
  33. * @param value Whether the indicator should be determinate.
  34. */
  35. set determinate(value: boolean);
  36. /**
  37. * Sets the current progress value. In indeterminate mode, this has no
  38. * visual effect but will be reflected if the indicator is switched to
  39. * determinate mode.
  40. * @param value The current progress value, which must be between 0 and 1.
  41. */
  42. set progress(value: number);
  43. /**
  44. * Whether the progress indicator is hidden.
  45. */
  46. get isClosed(): boolean;
  47. /**
  48. * Shows the progress indicator.
  49. */
  50. open(): void;
  51. /**
  52. * Hides the progress indicator.
  53. */
  54. close(): void;
  55. getDefaultFoundation(): MDCCircularProgressFoundation;
  56. }