component.d.ts 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  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 { MDCRipple, MDCRippleFactory } from '@material/ripple/component';
  25. import { MDCRippleCapableSurface } from '@material/ripple/types';
  26. import { MDCSegmentedButtonSegmentFoundation } from './foundation';
  27. /**
  28. * MDCSegmentedButtonSegment factory type.
  29. */
  30. export declare type MDCSegmentedButtonSegmentFactory = (el: HTMLElement, foundation?: MDCSegmentedButtonSegmentFoundation) => MDCSegmentedButtonSegment;
  31. /**
  32. * Implementation of MDCSegmentedButtonSegmentFoundation
  33. */
  34. export declare class MDCSegmentedButtonSegment extends MDCComponent<MDCSegmentedButtonSegmentFoundation> implements MDCRippleCapableSurface {
  35. get ripple(): MDCRipple;
  36. static attachTo(root: HTMLElement): MDCSegmentedButtonSegment;
  37. private index;
  38. private isSingleSelect;
  39. private rippleComponent;
  40. private handleClick;
  41. initialize(rippleFactory?: MDCRippleFactory): void;
  42. initialSyncWithDOM(): void;
  43. destroy(): void;
  44. getDefaultFoundation(): MDCSegmentedButtonSegmentFoundation;
  45. /**
  46. * Sets segment's index value
  47. *
  48. * @param index Segment's index within wrapping segmented button
  49. */
  50. setIndex(index: number): void;
  51. /**
  52. * Sets segment's isSingleSelect value
  53. *
  54. * @param isSingleSelect True if wrapping segmented button is single select
  55. */
  56. setIsSingleSelect(isSingleSelect: boolean): void;
  57. /**
  58. * @return Returns true if segment is currently selected, otherwise returns
  59. * false
  60. */
  61. isSelected(): boolean;
  62. /**
  63. * Sets segment to be selected
  64. */
  65. setSelected(): void;
  66. /**
  67. * Sets segment to be not selected
  68. */
  69. setUnselected(): void;
  70. /**
  71. * @return Returns segment's segmentId if it was set by client
  72. */
  73. getSegmentId(): string | undefined;
  74. }