UNPKG

2.48 kBTypeScriptView Raw
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 */
23import { MDCChipActionType } from '../action/constants';
24import { MDCChipActionInteractionEventDetail, MDCChipActionNavigationEventDetail } from '../action/types';
25import { MDCChipAnimation } from './constants';
26/** MDCChipInteractionEventDetail provides details for the interaction event. */
27export interface MDCChipInteractionEventDetail {
28 actionID: string;
29 chipID: string;
30 source: MDCChipActionType;
31 shouldRemove: boolean;
32 isSelectable: boolean;
33 isSelected: boolean;
34}
35/** MDCChipNavigationEventDetail provides details for the navigation event. */
36export interface MDCChipNavigationEventDetail {
37 chipID: string;
38 source: MDCChipActionType;
39 key: string;
40 isRTL: boolean;
41}
42/**
43 * MDCChipAnimationEventDetail provides details for the animation event.
44 */
45export interface MDCChipAnimationEventDetail {
46 chipID: string;
47 animation: MDCChipAnimation;
48 isComplete: boolean;
49 addedAnnouncement?: string;
50 removedAnnouncement?: string;
51}
52/**
53 * MDCChipActionInteractionEvent is the custom event for the interaction event.
54 */
55export declare type ActionInteractionEvent = CustomEvent<MDCChipActionInteractionEventDetail>;
56/**
57 * MDCChipActionInteractionEvent is the custom event for the interaction event.
58 */
59export declare type ActionNavigationEvent = CustomEvent<MDCChipActionNavigationEventDetail>;