component.d.ts 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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 { MDCSliderFoundation } from './foundation';
  25. /** Vanilla implementation of slider component. */
  26. export declare class MDCSlider extends MDCComponent<MDCSliderFoundation> {
  27. static attachTo(root: HTMLElement, options?: {
  28. skipInitialUIUpdate?: boolean;
  29. }): MDCSlider;
  30. private inputs;
  31. private thumbs;
  32. private trackActive;
  33. private ripples;
  34. private skipInitialUIUpdate;
  35. private valueToAriaValueTextFn;
  36. getDefaultFoundation(): MDCSliderFoundation;
  37. /**
  38. * Initializes component, with the following options:
  39. * - `skipInitialUIUpdate`: Whether to skip updating the UI when initially
  40. * syncing with the DOM. This should be enabled when the slider position
  41. * is set before component initialization.
  42. */
  43. initialize({ skipInitialUIUpdate }?: {
  44. skipInitialUIUpdate?: boolean;
  45. }): void;
  46. initialSyncWithDOM(): void;
  47. /** Redraws UI based on DOM (e.g. element dimensions, RTL). */
  48. layout(): void;
  49. getValueStart(): number;
  50. setValueStart(valueStart: number): void;
  51. getValue(): number;
  52. setValue(value: number): void;
  53. /** @return Slider disabled state. */
  54. getDisabled(): boolean;
  55. /** Sets slider disabled state. */
  56. setDisabled(disabled: boolean): void;
  57. /**
  58. * Sets a function that maps the slider value to the value of the
  59. * `aria-valuetext` attribute on the thumb element.
  60. */
  61. setValueToAriaValueTextFn(mapFn: ((value: number) => string) | null): void;
  62. private getThumbEl;
  63. private getInput;
  64. private getRipple;
  65. /** Adds tick mark elements to the given container. */
  66. private addTickMarks;
  67. /** Updates tick mark elements' classes in the given container. */
  68. private updateTickMarks;
  69. /** Initializes thumb ripples. */
  70. private createRipples;
  71. }