UNPKG

3.27 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2016 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 { MDCComponent } from '@material/base/component';
24import { MDCRipple, MDCRippleFactory } from '@material/ripple/component';
25import { MDCRippleCapableSurface } from '@material/ripple/types';
26import { MDCChipTrailingActionFactory } from '../trailingaction/component';
27import { MDCChipFoundation } from './foundation';
28export declare type MDCChipFactory = (el: Element, foundation?: MDCChipFoundation) => MDCChip;
29export declare class MDCChip extends MDCComponent<MDCChipFoundation> implements MDCRippleCapableSurface {
30 /**
31 * @return Whether the chip is selected.
32 */
33 get selected(): boolean;
34 /**
35 * Sets selected state on the chip.
36 */
37 set selected(selected: boolean);
38 /**
39 * @return Whether a trailing icon click should trigger exit/removal of the chip.
40 */
41 get shouldRemoveOnTrailingIconClick(): boolean;
42 /**
43 * Sets whether a trailing icon click should trigger exit/removal of the chip.
44 */
45 set shouldRemoveOnTrailingIconClick(shouldRemove: boolean);
46 /**
47 * Sets whether a clicking on the chip should focus the primary action.
48 */
49 set setShouldFocusPrimaryActionOnClick(shouldFocus: boolean);
50 get ripple(): MDCRipple;
51 get id(): string;
52 static attachTo(root: Element): MDCChip;
53 private leadingIcon;
54 private checkmark;
55 private primaryAction;
56 private trailingAction;
57 private rippleSurface;
58 private handleTrailingActionInteraction;
59 private handleTrailingActionNavigation;
60 private handleTransitionEnd;
61 private handleClick;
62 private handleKeydown;
63 private handleFocusIn;
64 private handleFocusOut;
65 initialize(rippleFactory?: MDCRippleFactory, trailingActionFactory?: MDCChipTrailingActionFactory): void;
66 initialSyncWithDOM(): void;
67 destroy(): void;
68 /**
69 * Begins the exit animation which leads to removal of the chip.
70 */
71 beginExit(): void;
72 getDefaultFoundation(): MDCChipFoundation;
73 setSelectedFromChipSet(selected: boolean, shouldNotifyClients: boolean): void;
74 focusPrimaryAction(): void;
75 focusTrailingAction(): void;
76 removeFocus(): void;
77 remove(): void;
78}