@material/ripple/component.d.ts

The Material Components for the web Ink Ripple effect for web element interactions

/**
 * @license
 * Copyright 2016 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 { MDCComponent } from '@material/base/component';
import { MDCRippleAdapter } from './adapter';
import { MDCRippleFoundation } from './foundation';
import { MDCRippleAttachOpts, MDCRippleCapableSurface } from './types';
export declare type MDCRippleFactory = (el: Element, foundation?: MDCRippleFoundation) => MDCRipple;
export declare class MDCRipple extends MDCComponent<MDCRippleFoundation> implements MDCRippleCapableSurface {
    static attachTo(root: Element, opts?: MDCRippleAttachOpts): MDCRipple;
    static createAdapter(instance: MDCRippleCapableSurface): MDCRippleAdapter;
    disabled: boolean;
    private isUnbounded?;
    get unbounded(): boolean;
    set unbounded(unbounded: boolean);
    activate(): void;
    deactivate(): void;
    layout(): void;
    getDefaultFoundation(): MDCRippleFoundation;
    initialSyncWithDOM(): void;
    /**
     * Closure Compiler throws an access control error when directly accessing a
     * protected or private property inside a getter/setter, like unbounded above.
     * By accessing the protected property inside a method, we solve that problem.
     * That's why this function exists.
     */
    private setUnbounded;
}