foundation.ts 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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. /**
  24. * The interface for the foundation of MDC's progress indicators.
  25. *
  26. * @public
  27. */
  28. export interface MDCProgressIndicatorFoundation {
  29. /**
  30. * Toggles the component between the determinate and indeterminate state.
  31. *
  32. * @param isDeterminate - Whether the component is in determinate state
  33. */
  34. setDeterminate(isDeterminate: boolean): void;
  35. /**
  36. * @return Whether the component is determinate.
  37. */
  38. isDeterminate(): boolean;
  39. /**
  40. * Sets the current progress value.
  41. *
  42. * @param value - the current progress value, should be between [0,1]
  43. */
  44. setProgress(value: number): void;
  45. /**
  46. * @return the current progress value [0,1];
  47. */
  48. getProgress(): number;
  49. /**
  50. * Puts the component in the open state.
  51. */
  52. open(): void;
  53. /**
  54. * Puts the component in the closed state.
  55. */
  56. close(): void;
  57. /**
  58. * @return Whether the component is closed.
  59. */
  60. isClosed(): boolean;
  61. }