foundation.d.ts 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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 { MDCFoundation } from '@material/base/foundation';
  24. import { MDCChipActionFocusBehavior, MDCChipActionType } from '../action/constants';
  25. import { MDCChipAdapter } from './adapter';
  26. import { MDCChipAnimation } from './constants';
  27. import { ActionInteractionEvent, ActionNavigationEvent } from './types';
  28. /**
  29. * MDCChipFoundation provides a foundation for all chips.
  30. */
  31. export declare class MDCChipFoundation extends MDCFoundation<MDCChipAdapter> {
  32. static get defaultAdapter(): MDCChipAdapter;
  33. private readonly animFrame;
  34. constructor(adapter?: Partial<MDCChipAdapter>);
  35. destroy(): void;
  36. getElementID(): string;
  37. setDisabled(isDisabled: boolean): void;
  38. isDisabled(): boolean;
  39. getActions(): MDCChipActionType[];
  40. isActionFocusable(action: MDCChipActionType): boolean;
  41. isActionSelectable(action: MDCChipActionType): boolean;
  42. isActionSelected(action: MDCChipActionType): boolean;
  43. setActionFocus(action: MDCChipActionType, focus: MDCChipActionFocusBehavior): void;
  44. setActionSelected(action: MDCChipActionType, isSelected: boolean): void;
  45. startAnimation(animation: MDCChipAnimation): void;
  46. handleAnimationEnd(event: AnimationEvent): void;
  47. handleTransitionEnd(): void;
  48. handleActionInteraction({ detail }: ActionInteractionEvent): void;
  49. handleActionNavigation({ detail }: ActionNavigationEvent): void;
  50. private directionFromKey;
  51. private navigateActions;
  52. private shouldRemove;
  53. private getRemovedAnnouncement;
  54. private getAddedAnnouncement;
  55. private animateSelection;
  56. private resetAnimationStyles;
  57. private updateSelectionStyles;
  58. }
  59. export default MDCChipFoundation;