isRippleEnabled

Commons
stable

Type guard that returns true when the ripple effect should be active: when the value is undefined (default-on) or any truthy value. Mirrors isHoverEnabled for the ripple directive.

API

Signature

Full TypeScript signature sourced from the util file.

typescript

API

Parameters

Input parameters accepted by this util.

value
required
any
The raw directive binding value. undefined means the directive was applied without a value and ripple is enabled by default; any falsy non-undefined value disables the ripple.

API

Return value

The value returned by this util.

true when ripple is enabled (value is undefined or truthy), narrowing the type to true. false otherwise.

Usage

Examples

Ready-to-paste usage snippets.

Checking ripple state from a directive binding

typescript