docs(ripple): update documentation #7941
Conversation
* Improves the documentation of the `matRipple` attribute directive. References angular#7543.
googlebot
added
the
cla: yes
src/lib/core/ripple/ripple.md
Outdated
| ``` | ||
|
|
||
| By default, a ripple is activated when the host element of the `matRipple` directive receives | ||
| mouse or touch events. Once element is being pressed, a ripple starts fading in from the point |
There was a problem hiding this comment.
"Once element is being pressed..." ->
"Upon being pressed, a ripple will begin fading in from the point of contact, radiating to cover the host element"
src/lib/core/ripple/ripple.md
Outdated
| mouse or touch events. Once element is being pressed, a ripple starts fading in from the point | ||
| of contact and expands circularly to cover the full host element. | ||
|
|
||
| As long as the user does not release the element, the ripples will not fade out. Releasing the |
There was a problem hiding this comment.
"Each ripple will fade out only upon release of the mouse or touch"
src/lib/core/ripple/ripple.md
Outdated
|
|
||
| ### Ripple trigger | ||
|
|
||
| As mentioned previously, by default ripples will fade in on interaction with the directive's |
There was a problem hiding this comment.
Omit "As mentioned previously"
src/lib/core/ripple/ripple.md
Outdated
| As mentioned previously, by default ripples will fade in on interaction with the directive's | ||
| host element. | ||
|
|
||
| In some situations, developers may want to show ripples on interaction with *another* element, |
There was a problem hiding this comment.
Combine with previous paragraph
src/lib/core/ripple/ripple.md
Outdated
| As mentioned previously, by default ripples will fade in on interaction with the directive's | ||
| host element. | ||
|
|
||
| In some situations, developers may want to show ripples on interaction with *another* element, |
src/lib/core/ripple/ripple.md
Outdated
| In some situations, developers may want to show ripples on interaction with *another* element, | ||
| but still want to have the ripples placed in another location. | ||
|
|
||
| This can be done by specifying the `matRippleTrigger` option that expects a reference to a |
There was a problem hiding this comment.
Combine with previous paragraph
src/lib/core/ripple/ripple.md
Outdated
| In some situations, developers may want to show ripples on interaction with *another* element, | ||
| but still want to have the ripples placed in another location. | ||
|
|
||
| This can be done by specifying the `matRippleTrigger` option that expects a reference to a |
| }) | ||
| ``` | ||
|
|
||
| All currently available global options are shown here: |
There was a problem hiding this comment.
Could this just be captured by API docs?
There was a problem hiding this comment.
Interfaces are not being displayed in the docs yet. We might be able to change the interface to a class, but I'd rather would like to setup Dgeni to show interfaces (in a follow-up)
src/lib/core/ripple/ripple.md
Outdated
| @@ -0,0 +1,95 @@ | |||
| # matRipple | |||
There was a problem hiding this comment.
Omit the top #matRipple header (it is added by the docs site)
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
matRippleattribute directive.References #7543.