component.d.ts 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  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 { MDCSegmentedButtonSegment, MDCSegmentedButtonSegmentFactory } from '../segment/component';
  25. import { SegmentDetail } from '../types';
  26. import { MDCSegmentedButtonFoundation } from './foundation';
  27. /** MDC Segmented Button */
  28. export declare class MDCSegmentedButton extends MDCComponent<MDCSegmentedButtonFoundation> {
  29. static attachTo(root: HTMLElement): MDCSegmentedButton;
  30. get segments(): readonly MDCSegmentedButtonSegment[];
  31. private segmentsList;
  32. private segmentFactory;
  33. private handleSelected;
  34. initialize(segmentFactory?: MDCSegmentedButtonSegmentFactory): void;
  35. /**
  36. * @param segmentFactory Factory to create new child segments
  37. * @return Returns list of child segments found in DOM
  38. */
  39. private instantiateSegments;
  40. initialSyncWithDOM(): void;
  41. destroy(): void;
  42. getDefaultFoundation(): MDCSegmentedButtonFoundation;
  43. /**
  44. * @return Returns readonly list of selected child segments as SegmentDetails
  45. */
  46. getSelectedSegments(): readonly SegmentDetail[];
  47. /**
  48. * Sets identified segment to be selected
  49. *
  50. * @param indexOrSegmentId Number index or string segmentId that identifies
  51. * child segment
  52. */
  53. selectSegment(indexOrSegmentId: number | string): void;
  54. /**
  55. * Sets identified segment to be not selected
  56. *
  57. * @param indexOrSegmentId Number index or string segmentId that identifies
  58. * child segment
  59. */
  60. unselectSegment(indexOrSegmentId: number | string): void;
  61. /**
  62. * @param indexOrSegmentId Number index or string segmentId that identifies
  63. * child segment
  64. * @return Returns true if identified child segment is currently selected,
  65. * otherwise returns false
  66. */
  67. isSegmentSelected(indexOrSegmentId: number | string): boolean;
  68. /**
  69. * @return Returns child segments mapped to readonly SegmentDetail list
  70. */
  71. private mappedSegments;
  72. }