Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stratiformltd/react-loadable-visibility
A wrapper around react-loadable and @loadable/component to load elements once they are visible on the page.
https://github.com/stratiformltd/react-loadable-visibility
Last synced: 30 days ago
JSON representation
A wrapper around react-loadable and @loadable/component to load elements once they are visible on the page.
- Host: GitHub
- URL: https://github.com/stratiformltd/react-loadable-visibility
- Owner: stratiformltd
- License: bsd-3-clause
- Created: 2017-07-09T17:04:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:41:18.000Z (almost 2 years ago)
- Last Synced: 2024-10-01T18:05:47.692Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 511 KB
- Stars: 1,008
- Watchers: 7
- Forks: 31
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `react-loadable-visibility`
> A wrapper around [react-loadable](https://github.com/thejameskyle/react-loadable) and [@loadable/component](https://github.com/smooth-code/loadable-components), only loading imports that are visible on the page.
[](https://badge.fury.io/js/react-loadable-visibility) [](https://travis-ci.org/stratiformltd/react-loadable-visibility)
## Example using `react-loadable`
```js
import LoadableVisibility from "react-loadable-visibility/react-loadable";
import Loading from "./my-loading-component";
const LoadableComponent = LoadableVisibility({
loader: () => import("./my-component"),
loading: Loading
});
export default function App() {
return ;
}
```
## Example using `@loadable/component`
```js
import loadableVisibility from "react-loadable-visibility/loadable-components";
import Loading from "./my-loading-component";
const LoadableComponent = loadableVisibility(() => import("./my-component"), {
fallback:
});
export default function App() {
return ;
}
```
## Options
The API is exactly the same as the original library. Please refer to their documentation:
- [react-loadable documentation](https://github.com/thejameskyle/react-loadable#guide)
- [@loadable/component documentation](https://github.com/smooth-code/loadable-components#docs)
Note that you'll need to have `react-loadable` or `@loadable/component` in your `package.json`.
# How does this work?
It's in essence a wrapper around `loadable` libraries with hooks into an [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) to inform us of when a given element is in the viewport.
Therefore, it will only function in [browsers that have the `IntersectionObserver` API](http://caniuse.com/#feat=intersectionobserver).
[A polyfill for `IntersectionObserver` is available](https://github.com/w3c/IntersectionObserver/tree/master/polyfill) however I am skeptical of its performance but have not tested it fully to offer a recommendation here. If you have any comments about this, feel free to open a PR and adjust this README!
If you choose the use the polyfill, you can load it via a [polyfill.io](https://cdn.polyfill.io/v3/) script - ``
Otherwise if the `IntersectionObserver` API is not available, we will revert back to just using `react-loadable` or `@loadable/component` itself.
# Why do I want this?
`react-loadable` and `@loadable/component` are fantastic higher level components to load additional modules once they are mounted on your page. It's great for keeping your bundle size small and pulling in a larger payload when the required components are part of your tree.
However it will not account for the content that's currently visible on your page, and only load what's actually visible to the end user. If you have a long page and are loading the entire content of that page for the user, even though they may only be able to see the content [above the fold](https://www.optimizely.com/optimization-glossary/above-the-fold/), it can be wasteful and especially detrimental in a mobile context.
`react-loadable-visibility` is positioned to solve these issues by leveraging the existing awesome API of `loadable` libraries with an extension to only trigger the loading of additional content once that component comes into view.
## Contributors
We'd like to thank the following people for their contributions:
- [Tasveer Singh](https://twitter.com/tazsingh)
- [Bergé Greg](https://twitter.com/neoziro)
Have a look at the [GitHub contributors page](https://github.com/stratiformltd/react-loadable-visibility/graphs/contributors) for a full list of all contributors.
## License
`react-loadable-visibility` may be redistributed according to the [BSD 3-Clause License](LICENSE).
Copyright 2019, Stratiform Limited.