Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gm0t/react-sticky-el
https://github.com/gm0t/react-sticky-el
npm-package react react-component reactjs
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/gm0t/react-sticky-el
- Owner: gm0t
- License: mit
- Created: 2016-12-28T11:32:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-19T02:37:32.000Z (about 2 months ago)
- Last Synced: 2024-10-04T19:32:52.105Z (about 1 month ago)
- Topics: npm-package, react, react-component, reactjs
- Language: TypeScript
- Size: 8.09 MB
- Stars: 254
- Watchers: 2
- Forks: 47
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
react-sticky-el
============
Sticky library for React.
#### Demos
- [Basic](http://rawgit.com/gm0t/react-sticky-el/master/storybook-static/index.html)
## Installation
```sh
npm install react-sticky-el
```
## Overview & Basic Example
The elements you actually want to "stick" should be wrapped in the `` tag. The full list of props are available below, but typical usage will look something like so:
app.jsx
```js
import React, {Component} from 'react';
import Sticky from 'react-sticky-el';
...
class App extends Component ({
render() {
return (
...
...
...
);
},
});
```
This will be rendered as:
```html
...
```
'Sticky' will be - `wrapper element`, `holder element` is used to reserve space in DOM when `holder element` has 'fixed' position.
When the "stickiness" becomes activated, the following inline style rules are applied to the Sticky element:
```css
position: fixed;
top: 0;
left: 0;
width:
```
Note that the calculation of the Sticky element's height does not currently take margins into account. If you have margins on this element it may result in unexpected behavior.
### `` Props
#### mode _(default: 'top')_
'top' or 'bottom' - to which side element should stick
#### disabled _(default: false)_
Allows you to disable sticking by setting this prop to `true`
#### onFixedToggle _(default: null)_
This handler will be called right before changing `fixed` state.
#### boundaryElement _(default: null)_
Selector to define a `boundaryElement`.
It should be one of the parents of the current element.
Look at these examples
- [With Boundary Element](https://rawgit.com/gm0t/react-sticky-el/master/storybook-static/index.html?path=/story/hideonboundaryhit--hide-on-boundary-hit-1)
- [No Boundary Element](https://rawgit.com/gm0t/react-sticky-el/master/storybook-static/index.html?path=/story/boundaryelement--no-boundary-header).
#### scrollElement _(default: window)_
Selector to define a `scrollElement`. All position checks will be performed according to this element, also it will be listened for 'scroll' event.
It should be one of the parents of the current element.
Possible selectors: 'body', 'window', '#{id}', anything suitable for [Element.matches](https://developer.mozilla.org/ru/docs/Web/API/Element/matches).
Look at the [Demos](https://rawgit.com/gm0t/react-sticky-el/master/storybook-static/index.html) for an example
app.jsx
```js
import React, {Component} from 'react';
import Sticky from 'react-sticky-el';
class App extends Component {
render() {
return (
....
Scroll pane
....
);
}
}
```
#### positionRecheckInterval _(default: 0)_
If your DOM structure is mutating (you are adding/removing elements), it will be usefull to provide `positionRecheckInterval` greater than zero, in this case position check will be also performed using setInterval in addition to scroll events.
#### stickyStyle _(default: {})_
In the event that you wish to override the style rules applied, simply pass in the style object as a prop:
app.jsx
```js
```
Note: You likely want to avoid messing with the following attributes in your stickyStyle: `left`, `top`, and `width`.
#### stickyClassName _(default: 'sticky')_
You can also specify a class name to be applied when the element becomes sticky:
app.jsx
```js
```
#### topOffset _(default: 0)_
Sticky state will be triggered when the top of the element is `topOffset` pixels from the top of the `scrollElement`. Positive numbers give the impression of a lazy sticky state, whereas negative numbers are more eager in their attachment
app.jsx
```js
```
Look at the [Basic Demo](https://rawgit.com/gm0t/react-sticky-el/master/storybook-static/index.html?path=/story/offsets--top-offset) for an example
#### bottomOffset _(default: 0)_
Sticky state will be triggered when the bottom of the element is `bottomOffset` pixels from the bottom of the `scrollElement`.
app.jsx
```js
```
Look at the [Basic Demo](https://rawgit.com/gm0t/react-sticky-el/master/storybook-static/index.html?path=/story/offsets--bottom-offset) for an example
#### hideOnBoundaryHit _(default: true)_
If `false` then the sticky element won't disappear on reaching it's boundaries. A configuration like this is implemented below.
```js
import Sticky from 'react-sticky-el';
```
Look at the [Basic Demo](https://rawgit.com/gm0t/react-sticky-el/master/storybook-static/index.html) for an example.
Note: If the `scrollareaElement` is not at the top of the viewport, when the sticky element overflows it, it will stay visible. This can not be fixed with `overflow: hidden` because the sticky element has `position: fixed` and it's relative to the viewport. A solution is to use `clip-path: inset(0 0 0 0);` on the `scrollareaElement`. **This may have unforeseen consequences with other styles in your app - use caution**. You can see this happening in [this example](https://rawgit.com/gm0t/react-sticky-el/master/storybook-static/index.html?path=/story/hideonboundaryhit--hide-on-boundary-hit-4)
#### dontUpdateHolderHeightWhenSticky _(default: false)_
Controls whenever the `min-height` for holder element should be updated when element becomes sticky or not. You can set it to `true` if the height of your sticky element changes when it becomes sticky (e.g. only some part of the header is visible when it's sticky) and you want to avoid your content jumping up.
Look at the [Demo](https://rawgit.com/gm0t/react-sticky-el/master/storybook-static/index.html?path=/story/advanced--dont-update-holder-height-when-sticky) for an example.
#### Other props
All other props (such as className, style, etc..) will be applied to the `holder` element.
## Advanced usage
If you want to use some custom components and have more control, then you can use `RenderPropSticky`:
```js
import { RenderPropSticky } from 'react-sticky-el';
function StickyHeader() {
return (
{({ isFixed, wrapperStyles, wrapperRef, holderStyles, holderRef }) => (
I'm sticky!
)}
)
}
```
## License
MIT