component.d.ts 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. /**
  2. * @license
  3. * Copyright 2018 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 { MDCChipActionFactory } from '../action/component';
  25. import { MDCChipActionFocusBehavior, MDCChipActionType } from '../action/constants';
  26. import { MDCChipAnimation } from './constants';
  27. import { MDCChipFoundation } from './foundation';
  28. /**
  29. * MDCChipFactory is used by the parent MDCChipSet component to initialize
  30. * chips.
  31. */
  32. export declare type MDCChipFactory = (el: HTMLElement, foundation?: MDCChipFoundation) => MDCChip;
  33. /**
  34. * MDCChip provides component encapsulation of the foundation implementation.
  35. */
  36. export declare class MDCChip extends MDCComponent<MDCChipFoundation> {
  37. static attachTo(root: HTMLElement): MDCChip;
  38. private handleActionInteraction;
  39. private handleActionNavigation;
  40. private actions;
  41. initialize(actionFactory?: MDCChipActionFactory): void;
  42. initialSyncWithDOM(): void;
  43. destroy(): void;
  44. getDefaultFoundation(): MDCChipFoundation;
  45. /** Exposed to be called by the parent chip set. */
  46. remove(): void;
  47. /** Returns the MDCChipActionTypes for the encapsulated actions. */
  48. getActions(): MDCChipActionType[];
  49. /** Returns the ID of the root element. */
  50. getElementID(): string;
  51. isDisabled(): boolean;
  52. setDisabled(isDisabled: boolean): void;
  53. /** Returns the focusability of the action. */
  54. isActionFocusable(action: MDCChipActionType): boolean;
  55. /** Returns the selectability of the action. */
  56. isActionSelectable(action: MDCChipActionType): boolean;
  57. /** Returns the selected state of the action. */
  58. isActionSelected(action: MDCChipActionType): boolean;
  59. /** Sets the focus behavior of the action. */
  60. setActionFocus(action: MDCChipActionType, focus: MDCChipActionFocusBehavior): void;
  61. /** Sets the selected state of the action. */
  62. setActionSelected(action: MDCChipActionType, isSelected: boolean): void;
  63. /** Starts the animation on the chip. */
  64. startAnimation(animation: MDCChipAnimation): void;
  65. }