skills/angular__angular
1
0
Fork 0
mirror of https://github.com/angular/angular.git synced 2026-09-14 13:54:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(ripple): add section about global options (#4239)

Browse Source 
* docs(ripple): add section about global options

* Adds a new section about global ripple options to the `README.md` file of the ripple directive.

Closes #4226

* Update
This commit is contained in:
Paul Gschwendtner
2017-04-28 19:20:48 +02:00
committed by mmalerba
parent f16affc69f
commit 3560ada60e
1 changed files with 25 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/lib/core/ripple/README.md
+25 -2
View File
@@ -6,10 +6,33 @@ By default, a ripple is activated when the host element of the `md-ripple` direc
Ripples can also be triggered programmatically by getting a reference to the MdRipple directive and calling its `start` and `end` methods.
### Global options
### Upcoming work
Developers are able to specify options for all ripples inside of their application.
Ripples will be added to the `md-button`, `md-radio-button`, `md-checkbox`, and `md-nav-list` components.
The speed of the ripples can be adjusted and the ripples can be disabled globally as well.
Global ripple options can be specified by setting the `MD_RIPPLE_GLOBAL_OPTIONS` provider.
```ts
const globalRippleConfig: RippleGlobalOptions = {
disabled: true,
baseSpeedFactor: 1.5 // Ripples will animate 50% faster than before.
}
@NgModule({
providers: [
{provide: MD_RIPPLE_GLOBAL_OPTIONS, useValue: globalRippleConfig}
]
})
```
Here are all available global options listed:
| Name | Type | Description |
| --------------- | ------- | ----------------------------------------- |
| disabled | boolean | Whether ripples should show or not. |
| baseSpeedFactor | number | Factor to adjust ripple speed. |
### API Summary