lolmausember-scroll-to-mk2
A link/button component that performs scrolling to given selector.
Current implementation uses jQuery for animated scrolling (animation is optional).
Reimplementation of ember-scroll-to
This project is a reimplementation of ember-scroll-to by @jasonkriss and other contributors.
Differences:
ember-scroll-to-mk2only provides the component, not the service.- Scrolls to any selector, not just id.
- Allows specifying which container to scroll.
- Optional caching of container and target elements -- disable caching if your app has them disappearing/reappearing.
Installation
ember install ember-scroll-to-mk2Usage
Inline form:
{{scroll-to
target = "#foo"
label = "Scroll to #foo"
}}Block form:
{{#scroll-to
target = "#foo"
}}
<strong>Scroll to #foo"</strong>
{{/scroll-to}}Arguments
| Argument | Type | Default value | Description |
|---|---|---|---|
label |
undefined/String |
undefined |
If no block is provided, this is used as link/button label. |
target |
String |
<required> | Selector of the element to scroll to |
scrollable |
String |
'html, body' |
Selector of the element being scrolled. In test env, '#ember-testing-container' is used. |
duration |
undefined/Number |
undefined |
Animation duration in milliseconds. When undefined, jQuery's default is used. |
easing |
undefined/String |
undefined |
Animation easing name. When undefined, jQuery's default is used. |
offset |
Number |
0 |
Lets you scroll slightly above or below the target. |
cacheTarget |
Boolean |
true |
Whether to cache the target element. |
cacheScrollable |
Boolean |
true |
Whether to cache the scrollable element. |
afterScroll |
undefined/Action |
undefined |
Ember Action to invoke every time scrolling animation completes. |
shouldAccountForScrollable |
Boolean |
false if scrollable is not default |
Whether to account for scollable's offset and scolllTop when calculating scolllTop. |
License
This software is free to use under the MIT license. See the LICENSE file for license text and copyright information.
Includes fragments of code borrowed from jasonkriss/ember-scroll-to.