UNPKG

1.51 kBMarkdownView Raw
1# Using the Sticky Header/Footer Plugin
2
3If you'd like to disable scrolling within the grid container, in favor of an infinite scroll UI you can use the sticky header/footer feature.
4
5```javascript
6export const plugins = {
7 STICKY_HEADER: {
8 enabled: true,
9 scrollTarget: '#my-scrollable-div',
10 listener: customFunc
11 },
12 STICKY_FOOTER: {
13 enabled: true,
14 scrollTarget: '#my-scrollable-div',
15 listener: customFunc
16 }
17}
18```
19
20| Prop | Type | Description |
21|---------------------------|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
22| enabled | bool | whether the sticky header is initialized |
23| scrollTarget | string | optional, useds as a selector to find the scrollable parent, ex. '.page-container' |
24| listener | func | optional, custom function to be called on scroll |