[6a3a178] | 1 | /**
|
---|
| 2 | * @license
|
---|
| 3 | * Copyright Google LLC All Rights Reserved.
|
---|
| 4 | *
|
---|
| 5 | * Use of this source code is governed by an MIT-style license that can be
|
---|
| 6 | * found in the LICENSE file at https://angular.io/license
|
---|
| 7 | */
|
---|
| 8 | import { Platform } from '@angular/cdk/platform';
|
---|
| 9 | import { ElementRef, InjectionToken, NgZone, OnDestroy, OnInit } from '@angular/core';
|
---|
| 10 | import { RippleAnimationConfig, RippleConfig, RippleRef } from './ripple-ref';
|
---|
| 11 | import { RippleTarget } from './ripple-renderer';
|
---|
| 12 | /** Configurable options for `matRipple`. */
|
---|
| 13 | import * as ɵngcc0 from '@angular/core';
|
---|
| 14 | export interface RippleGlobalOptions {
|
---|
| 15 | /**
|
---|
| 16 | * Whether ripples should be disabled. Ripples can be still launched manually by using
|
---|
| 17 | * the `launch()` method. Therefore focus indicators will still show up.
|
---|
| 18 | */
|
---|
| 19 | disabled?: boolean;
|
---|
| 20 | /**
|
---|
| 21 | * Default configuration for the animation duration of the ripples. There are two phases with
|
---|
| 22 | * different durations for the ripples: `enter` and `leave`. The durations will be overwritten
|
---|
| 23 | * by the value of `matRippleAnimation` or if the `NoopAnimationsModule` is included.
|
---|
| 24 | */
|
---|
| 25 | animation?: RippleAnimationConfig;
|
---|
| 26 | /**
|
---|
| 27 | * Whether ripples should start fading out immediately after the mouse or touch is released. By
|
---|
| 28 | * default, ripples will wait for the enter animation to complete and for mouse or touch release.
|
---|
| 29 | */
|
---|
| 30 | terminateOnPointerUp?: boolean;
|
---|
| 31 | }
|
---|
| 32 | /** Injection token that can be used to specify the global ripple options. */
|
---|
| 33 | export declare const MAT_RIPPLE_GLOBAL_OPTIONS: InjectionToken<RippleGlobalOptions>;
|
---|
| 34 | export declare class MatRipple implements OnInit, OnDestroy, RippleTarget {
|
---|
| 35 | private _elementRef;
|
---|
| 36 | private _animationMode?;
|
---|
| 37 | /** Custom color for all ripples. */
|
---|
| 38 | color: string;
|
---|
| 39 | /** Whether the ripples should be visible outside the component's bounds. */
|
---|
| 40 | unbounded: boolean;
|
---|
| 41 | /**
|
---|
| 42 | * Whether the ripple always originates from the center of the host element's bounds, rather
|
---|
| 43 | * than originating from the location of the click event.
|
---|
| 44 | */
|
---|
| 45 | centered: boolean;
|
---|
| 46 | /**
|
---|
| 47 | * If set, the radius in pixels of foreground ripples when fully expanded. If unset, the radius
|
---|
| 48 | * will be the distance from the center of the ripple to the furthest corner of the host element's
|
---|
| 49 | * bounding rectangle.
|
---|
| 50 | */
|
---|
| 51 | radius: number;
|
---|
| 52 | /**
|
---|
| 53 | * Configuration for the ripple animation. Allows modifying the enter and exit animation
|
---|
| 54 | * duration of the ripples. The animation durations will be overwritten if the
|
---|
| 55 | * `NoopAnimationsModule` is being used.
|
---|
| 56 | */
|
---|
| 57 | animation: RippleAnimationConfig;
|
---|
| 58 | /**
|
---|
| 59 | * Whether click events will not trigger the ripple. Ripples can be still launched manually
|
---|
| 60 | * by using the `launch()` method.
|
---|
| 61 | */
|
---|
| 62 | get disabled(): boolean;
|
---|
| 63 | set disabled(value: boolean);
|
---|
| 64 | private _disabled;
|
---|
| 65 | /**
|
---|
| 66 | * The element that triggers the ripple when click events are received.
|
---|
| 67 | * Defaults to the directive's host element.
|
---|
| 68 | */
|
---|
| 69 | get trigger(): HTMLElement;
|
---|
| 70 | set trigger(trigger: HTMLElement);
|
---|
| 71 | private _trigger;
|
---|
| 72 | /** Renderer for the ripple DOM manipulations. */
|
---|
| 73 | private _rippleRenderer;
|
---|
| 74 | /** Options that are set globally for all ripples. */
|
---|
| 75 | private _globalOptions;
|
---|
| 76 | /** Whether ripple directive is initialized and the input bindings are set. */
|
---|
| 77 | private _isInitialized;
|
---|
| 78 | constructor(_elementRef: ElementRef<HTMLElement>, ngZone: NgZone, platform: Platform, globalOptions?: RippleGlobalOptions, _animationMode?: string | undefined);
|
---|
| 79 | ngOnInit(): void;
|
---|
| 80 | ngOnDestroy(): void;
|
---|
| 81 | /** Fades out all currently showing ripple elements. */
|
---|
| 82 | fadeOutAll(): void;
|
---|
| 83 | /** Fades out all currently showing non-persistent ripple elements. */
|
---|
| 84 | fadeOutAllNonPersistent(): void;
|
---|
| 85 | /**
|
---|
| 86 | * Ripple configuration from the directive's input values.
|
---|
| 87 | * @docs-private Implemented as part of RippleTarget
|
---|
| 88 | */
|
---|
| 89 | get rippleConfig(): RippleConfig;
|
---|
| 90 | /**
|
---|
| 91 | * Whether ripples on pointer-down are disabled or not.
|
---|
| 92 | * @docs-private Implemented as part of RippleTarget
|
---|
| 93 | */
|
---|
| 94 | get rippleDisabled(): boolean;
|
---|
| 95 | /** Sets up the trigger event listeners if ripples are enabled. */
|
---|
| 96 | private _setupTriggerEventsIfEnabled;
|
---|
| 97 | /**
|
---|
| 98 | * Launches a manual ripple using the specified ripple configuration.
|
---|
| 99 | * @param config Configuration for the manual ripple.
|
---|
| 100 | */
|
---|
| 101 | launch(config: RippleConfig): RippleRef;
|
---|
| 102 | /**
|
---|
| 103 | * Launches a manual ripple at the specified coordinates relative to the viewport.
|
---|
| 104 | * @param x Coordinate along the X axis at which to fade-in the ripple. Coordinate
|
---|
| 105 | * should be relative to the viewport.
|
---|
| 106 | * @param y Coordinate along the Y axis at which to fade-in the ripple. Coordinate
|
---|
| 107 | * should be relative to the viewport.
|
---|
| 108 | * @param config Optional ripple configuration for the manual ripple.
|
---|
| 109 | */
|
---|
| 110 | launch(x: number, y: number, config?: RippleConfig): RippleRef;
|
---|
| 111 | static ɵfac: ɵngcc0.ɵɵFactoryDeclaration<MatRipple, [null, null, null, { optional: true; }, { optional: true; }]>;
|
---|
| 112 | static ɵdir: ɵngcc0.ɵɵDirectiveDeclaration<MatRipple, "[mat-ripple], [matRipple]", ["matRipple"], { "radius": "matRippleRadius"; "disabled": "matRippleDisabled"; "trigger": "matRippleTrigger"; "color": "matRippleColor"; "unbounded": "matRippleUnbounded"; "centered": "matRippleCentered"; "animation": "matRippleAnimation"; }, {}, never>;
|
---|
| 113 | }
|
---|
| 114 |
|
---|
| 115 | //# sourceMappingURL=ripple.d.ts.map |
---|