@material/chips/deprecated/chip/adapter.d.ts

The Material Components for the Web chips component

/**
 * @license
 * Copyright 2017 Google Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
import { EventSource } from './constants';
/**
 * Defines the shape of the adapter expected by the foundation.
 * Implement this adapter for your framework of choice to delegate updates to
 * the component in your framework of choice. See architecture documentation
 * for more details.
 * https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md
 */
export interface MDCChipAdapter {
    /**
     * Adds a class to the root element.
     */
    addClass(className: string): void;
    /**
     * Removes a class from the root element.
     */
    removeClass(className: string): void;
    /**
     * @return true if the root element contains the given class.
     */
    hasClass(className: string): boolean;
    /**
     * Adds a class to the leading icon element.
     */
    addClassToLeadingIcon(className: string): void;
    /**
     * Removes a class from the leading icon element.
     */
    removeClassFromLeadingIcon(className: string): void;
    /**
     * @return true if target has className, false otherwise.
     */
    eventTargetHasClass(target: EventTarget | null, className: string): boolean;
    /**
     * @return the attribute string value if present, otherwise null
     */
    getAttribute(attr: string): string | null;
    /**
     * Emits a custom "MDCChip:interaction" event denoting the chip has been
     * interacted with (typically on click or keydown).
     */
    notifyInteraction(): void;
    /**
     * Emits a custom "MDCChip:selection" event denoting the chip has been selected or deselected.
     */
    notifySelection(selected: boolean, chipSetShouldIgnore: boolean): void;
    /**
     * Emits a custom "MDCChip:trailingIconInteraction" event denoting the trailing icon has been
     * interacted with (typically on click or keydown).
     */
    notifyTrailingIconInteraction(): void;
    /**
     * Emits a custom event "MDCChip:removal" denoting the chip will be removed.
     */
    notifyRemoval(removedAnnouncement: string | null): void;
    /**
     * Emits a custom event "MDCChip:navigation" denoting a focus navigation event.
     */
    notifyNavigation(key: string, source: EventSource): void;
    /**
     * Emits when editing starts.
     */
    notifyEditStart(): void;
    /**
     * Emits when editing finishes.
     */
    notifyEditFinish(): void;
    /**
     * @return The computed property value of the given style property on the root element.
     */
    getComputedStyleValue(propertyName: string): string;
    /**
     * Sets the property value of the given style property on the root element.
     */
    setStyleProperty(propertyName: string, value: string): void;
    /**
     * @return Whether the chip has a leading icon.
     */
    hasLeadingIcon(): boolean;
    /**
     * @return The bounding client rect of the root element.
     */
    getRootBoundingClientRect(): DOMRect;
    /**
     * @return The bounding client rect of the checkmark element or null if it doesn't exist.
     */
    getCheckmarkBoundingClientRect(): DOMRect | null;
    /**
     * Sets the value of the attribute on the primary action content.
     */
    setPrimaryActionAttr(attr: string, value: string): void;
    /**
     * Gives focus to the primary action.
     */
    focusPrimaryAction(): void;
    /**
     * Sets focus to the trailing action.
     */
    focusTrailingAction(): void;
    /**
     * Removes focus from the trailing action.
     */
    removeTrailingActionFocus(): void;
    /**
     * Returns true if the trailing action is navigable.
     * Should return the value of MDCChipTrailingAction#isNavigable() or false.
     */
    isTrailingActionNavigable(): boolean;
    /**
     * @return true if the text direction is right-to-left.
     */
    isRTL(): boolean;
}