@blox/material
Version:
Material Components for Angular
70 lines (69 loc) • 3.39 kB
TypeScript
import { AfterContentInit, ElementRef, OnDestroy, Renderer2 } from '@angular/core';
import { AbstractMdcRipple } from '../ripple/abstract.mdc.ripple';
import { MdcEventRegistry } from '../../utils/mdc.event.registry';
/**
* Directive for making an element a ripple surface. The ripple can be customized
* with the provided
* <a href="https://github.com/material-components/material-components-web/tree/master/packages/mdc-ripple#sass-apis"
* target="_blank">Sass Mixins</a>.
* Alternatively you can set the <code>surface</code> to get a default styled ripple.
*/
export declare class MdcRippleDirective extends AbstractMdcRipple implements AfterContentInit, OnDestroy {
_elm: ElementRef;
private _initialized;
private _on;
private _disabled;
private _surface;
private _dim;
constructor(_elm: ElementRef, renderer: Renderer2, registry: MdcEventRegistry, doc: any);
ngAfterContentInit(): void;
ngOnDestroy(): void;
/**
* Set this input to false to remove the ripple effect from the surface.
*/
get mdcRipple(): boolean;
set mdcRipple(value: boolean);
static ngAcceptInputType_mdcRipple: boolean | '';
/**
* When this input has a value other than false, the ripple is unbounded.
* Surfaces for bounded ripples should have <code>overflow</code> set to hidden,
* while surfaces for unbounded ripples should have it set to <code>visible</code>.
*/
get unbounded(): boolean;
set unbounded(value: boolean);
static ngAcceptInputType_unbounded: boolean | '';
/**
* This input sets the dimension of the ripple.
* This input can be set to null for returning to the defaults, which uses the surface
* element to compute the bounds of the ripple.
*/
get dimension(): number | null;
set dimension(value: number | null);
static ngAcceptInputType_dimension: string | number | null;
/**
* This input can be used to programmatically enable/disable the ripple.
* When true, the ripple effect will be disabled, when false the ripple
* effect will be enabled. When not set, or <code>null</code> (default)
* the ripple effect enabled/disabled state depend on whether or not the
* surface element has the <code>disabled</code> attribute set.
*/
get disabled(): boolean | null;
set disabled(value: boolean | null);
static ngAcceptInputType_boolean: boolean | null | '';
/**
* When this input has a value other than false, the ripple element will get the
* "mdc-ripple-surface" class. That class has styling for bounded and unbounded
* ripples in accordance with your theme customizations. Without this property,
* you have to supply your own ripple styles, using the provided
* <a href="https://github.com/material-components/material-components-web/tree/master/packages/mdc-ripple#sass-apis"
* target="_blank">Sass Mixins</a>.
*
* To apply a standard surface ripple, set the value to `true`, `"primary"`, or `"accent"`.
* The values primary and accent set the ripple color to the theme primary or secondary color.
*/
get surface(): boolean | 'primary' | 'accent';
set surface(value: boolean | 'primary' | 'accent');
static ngAcceptInputType_surface: boolean | 'primary' | 'accent' | '';
get _surfacePrimary(): boolean;
get _surfaceAccent(): boolean;
}