lazy-react 3.3.0 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.codeclimate.yml +2 -2
- package/.eslintrc +17 -29
- package/README.md +35 -35
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -0
- package/package.json +17 -14
- package/{demo → src/demo}/index.html +1 -1
- package/src/demo/index.js +62 -0
- package/src/lazyLoadBackgroundImage.tsx +1 -1
- package/src/lazyLoadFrame.tsx +1 -1
- package/src/useIsInViewport.tsx +8 -11
- package/demo/demo.js +0 -70
- package/demo/index.js +0 -198
- package/demo/index.js.LICENSE.txt +0 -32
- package/tsconfig.json +0 -25
- package/webpack.config.demo.js +0 -19
- package/webpack.config.js +0 -38
package/.codeclimate.yml
CHANGED
package/.eslintrc
CHANGED
|
@@ -4,37 +4,25 @@
|
|
|
4
4
|
"es6": true,
|
|
5
5
|
"node": true
|
|
6
6
|
},
|
|
7
|
-
"
|
|
8
|
-
"
|
|
9
|
-
"ecmaFeatures": {
|
|
10
|
-
"experimentalObjectRestSpread": true,
|
|
11
|
-
"jsx": true
|
|
12
|
-
},
|
|
13
|
-
"sourceType": "module"
|
|
14
|
-
},
|
|
7
|
+
"root": true,
|
|
8
|
+
"parser": "@typescript-eslint/parser",
|
|
15
9
|
"plugins": [
|
|
16
|
-
"
|
|
10
|
+
"@typescript-eslint"
|
|
11
|
+
],
|
|
12
|
+
"extends": [
|
|
13
|
+
"eslint:recommended",
|
|
14
|
+
"plugin:react/recommended",
|
|
15
|
+
"prettier",
|
|
16
|
+
"plugin:@typescript-eslint/eslint-recommended",
|
|
17
|
+
"plugin:@typescript-eslint/recommended"
|
|
17
18
|
],
|
|
18
19
|
"rules": {
|
|
19
|
-
|
|
20
|
-
"
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
"
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
],
|
|
27
|
-
"quotes": [
|
|
28
|
-
2,
|
|
29
|
-
"single"
|
|
30
|
-
],
|
|
31
|
-
"semi": [
|
|
32
|
-
2,
|
|
33
|
-
"never"
|
|
34
|
-
],
|
|
35
|
-
"comma-spacing": [
|
|
36
|
-
2,
|
|
37
|
-
{ "before": false, "after": true }
|
|
38
|
-
]
|
|
20
|
+
"@typescript-eslint/ban-types": "off",
|
|
21
|
+
"@typescript-eslint/no-explicit-any": "off"
|
|
22
|
+
},
|
|
23
|
+
"settings": {
|
|
24
|
+
"react": {
|
|
25
|
+
"version": "detect"
|
|
26
|
+
}
|
|
39
27
|
}
|
|
40
28
|
}
|
package/README.md
CHANGED
|
@@ -52,7 +52,7 @@ Usage:
|
|
|
52
52
|
```javascript
|
|
53
53
|
|
|
54
54
|
<LazyComponent>
|
|
55
|
-
|
|
55
|
+
<ComponentToLoadWhenInViewport>
|
|
56
56
|
</LazyComponent>
|
|
57
57
|
|
|
58
58
|
```
|
|
@@ -90,7 +90,7 @@ style | Object | html style attribute | | {width:'100%'}
|
|
|
90
90
|
|
|
91
91
|
```javascript
|
|
92
92
|
//with es6
|
|
93
|
-
import {LazyBackgroundImage, LazyImage, LazyFrame, LazyComponent} from 'lazy-react'
|
|
93
|
+
import { LazyBackgroundImage, LazyImage, LazyFrame, LazyComponent } from 'lazy-react'
|
|
94
94
|
//with es5
|
|
95
95
|
var LazyBackgroundImage = require('lazy-react').LazyBackgroundImage
|
|
96
96
|
var LazyImage = require('lazy-react').LazyImage
|
|
@@ -98,28 +98,28 @@ var LazyFrame = require('lazy-react').LazyFrame
|
|
|
98
98
|
var LazyComponent = require('lazy-react').LazyComponent
|
|
99
99
|
|
|
100
100
|
class Example extends React.Component {
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
101
|
+
constructor(props) {
|
|
102
|
+
super(props)
|
|
103
|
+
}
|
|
104
|
+
render() {
|
|
105
|
+
return <div>
|
|
106
|
+
<LazyBackgroundImage
|
|
107
|
+
link={'https://images.unsplash.com/photo-1462834026679-7c03bf571a67?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=6e160dc1e65511df7bf1c461f8a93c82'}
|
|
108
|
+
className="fill"
|
|
109
|
+
/>
|
|
110
|
+
<LazyImage
|
|
111
|
+
link={'https://images.unsplash.com/photo-1462834026679-7c03bf571a67?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=6e160dc1e65511df7bf1c461f8a93c82'}
|
|
112
|
+
offset={100}
|
|
113
|
+
/>
|
|
114
|
+
<LazyFrame
|
|
115
|
+
link={'http://jonathanobino.xyz'}
|
|
116
|
+
scrolling={true}
|
|
117
|
+
/>
|
|
118
|
+
<LazyComponent>
|
|
119
|
+
<ComponentToLoadWhenInViewport>
|
|
120
|
+
</LazyComponent>
|
|
121
|
+
</div>
|
|
122
|
+
}
|
|
123
123
|
}
|
|
124
124
|
```
|
|
125
125
|
|
|
@@ -128,7 +128,7 @@ class Example extends React.Component {
|
|
|
128
128
|
Since version 3.x there is an hook available named 'useIsInViewport' that exposes 3 elements:
|
|
129
129
|
|
|
130
130
|
- setRef: used to set the ref of the dom that has to be in the viewport
|
|
131
|
-
- link: the passed link. It's equal to
|
|
131
|
+
- link: the passed link. It's equal to an empty string until the element is in the specified viewport
|
|
132
132
|
- isVisible: it's false until the element is in the specified viewport
|
|
133
133
|
|
|
134
134
|
|
|
@@ -138,18 +138,18 @@ Usage
|
|
|
138
138
|
|
|
139
139
|
import useIsInViewport from 'lazy-react'
|
|
140
140
|
|
|
141
|
-
function Example(
|
|
142
|
-
|
|
141
|
+
function Example({link, offset}) {
|
|
142
|
+
const [setRef, link, isVisible] = useIsInViewport({link, offset})
|
|
143
143
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
144
|
+
if(!isVisible){
|
|
145
|
+
return <Placeholder />
|
|
146
|
+
}
|
|
147
147
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
148
|
+
return <div ref={(node)=>{
|
|
149
|
+
setRef(node)
|
|
150
|
+
}}>
|
|
151
|
+
<Content/>
|
|
152
|
+
</div>
|
|
153
153
|
|
|
154
154
|
}
|
|
155
155
|
|
package/dist/index.js
CHANGED
|
@@ -1 +1,2 @@
|
|
|
1
|
-
|
|
1
|
+
var e,t=require("react/jsx-runtime"),n=require("react");function r(e,t,n,r){Object.defineProperty(e,t,{get:n,set:r,enumerable:!0,configurable:!0})}function l(e){const[r,l,i]=a(e),[o,s]=(0,n.useState)({backgroundImage:`url(${l})`,...e.style});return(0,n.useEffect)((()=>{s({backgroundImage:`url(${l})`,...e.style})}),[l,i]),(0,t.jsx)("div",{className:e.className,style:o,ref:e=>{r(e)},children:e.children})}function i(e){const[n,r]=a(e);return(0,t.jsx)("div",{ref:e=>{n(e)},children:(0,t.jsx)("img",{src:r,alt:e.alt,style:e.style,className:e.className})})}function o(e){const[n,r]=a(e);return(0,t.jsx)("iframe",{height:e.height||"500",scrolling:e.scrolling||"no",src:r,frameBorder:e.frameBorder||"no",allowFullScreen:e.allowFullScreen||!0,style:e.style||{},ref:e=>{n(e)},...e})}function s(e){const[n,r,l]=a(e);return l?(0,t.jsx)("div",{children:e.children}):(0,t.jsx)("div",{ref:e=>{n(e)},style:{height:"300px",width:"300px",...e.style}})}function a(e){const[t,r]=(0,n.useState)(""),[l,i]=(0,n.useState)(!1),[o,s]=(0,n.useState)(null),a=(0,n.useMemo)((()=>({element:o,makeItVisible:d,offset:e.offset||100})),[o,e]),c=(0,n.useCallback)((e=>{null!==e&&s(e)}),[]);function d(){e.link&&r((()=>e.link)),i((()=>!0))}return(0,n.useEffect)((()=>(null!==o&&u.addElement(a),()=>u.removeElementFromList(a))),[o]),[c,t,l]}e=module.exports,Object.defineProperty(e,"__esModule",{value:!0,configurable:!0}),r(module.exports,"default",(()=>a)),r(module.exports,"LazyBackgroundImage",(()=>l)),r(module.exports,"LazyImage",(()=>i)),r(module.exports,"LazyFrame",(()=>o)),r(module.exports,"LazyComponent",(()=>s));const c=new Set,u={isInViewPort:({offset:e,top:t,left:n})=>t<window.innerHeight+e&&n<window.innerWidth+e,calculateNewPosition:e=>{const{top:t,left:n}=e.element?.getBoundingClientRect()||{top:0,left:0};return{...e,top:t,left:n}},addElement:function(e){c.add(e),0===u.isListenerAttached&&(u.isListenerAttached=window.requestAnimationFrame(u.eventHandler))},eventHandler:function(){0===c.size?u.removeScrollHandler():(c.forEach((e=>{u.isInViewPort(u.calculateNewPosition(e))&&(e.makeItVisible(),u.removeElementFromList(e))})),u.isListenerAttached=window.requestAnimationFrame(u.eventHandler))},removeScrollHandler:function(){window.cancelAnimationFrame(u.isListenerAttached),u.isListenerAttached=0},removeElementFromList:function(e){c.delete(e)},isListenerAttached:0};
|
|
2
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"mJAGe,SAAAA,EAA6BC,GAC1C,MAAOC,EAAQC,EAAMC,GAAcC,EAAgBJ,IAE5CK,EAAOC,IAAY,EAAAC,EAAAC,UAAS,CACjCC,gBAAiB,OAAOP,QACrBF,EAAMK,QAUX,OAPA,EAAAE,EAAAG,YAAU,KACRJ,EAAS,CACPG,gBAAiB,OAAOP,QACrBF,EAAMK,OACT,GACD,CAACH,EAAMC,KAGR,EAAAQ,EAAAC,KAAC,MAAG,CACFC,UAAWb,EAAMa,UACjBR,MAAOA,EACPS,IAAMC,IACJd,EAAOc,EAAK,E,SAGbf,EAAMgB,U,CCvBE,SAAAC,EAAmBjB,GAChC,MAAOC,EAAQC,GAAQE,EAAgBJ,GAEvC,OACE,EAAAW,EAAAC,KAAC,MAAG,CACFE,IAAMC,IACJd,EAAOc,EAAK,E,UAGd,EAAAJ,EAAAC,KAAC,MAAG,CACFM,IAAKhB,EACLiB,IAAKnB,EAAMmB,IACXd,MAAOL,EAAMK,MACbQ,UAAWb,EAAMa,a,CCbV,SAAAO,EAAmBpB,GAChC,MAAOC,EAAQC,GAAQE,EAAgBJ,GAEvC,OACE,EAAAW,EAAAC,KAAC,SAAM,CACLS,OAAQrB,EAAMqB,QAAU,MACxBC,UAAWtB,EAAMsB,WAAa,KAC9BJ,IAAKhB,EACLqB,YAAavB,EAAMuB,aAAe,KAClCC,gBAAiBxB,EAAMwB,kBAAmB,EAC1CnB,MAAOL,EAAMK,OAAS,GACtBS,IAAMC,IACJd,EAAOc,EAAK,KAEVf,G,CCdK,SAAAyB,EAAuBzB,GACpC,MAAOC,EAAQC,EAAMwB,GAAatB,EAAgBJ,GAElD,OAAK0B,GAcE,EAAAf,EAAAC,KAAC,MAAG,C,SAAEZ,EAAMgB,YAZf,EAAAL,EAAAC,KAAC,MAAG,CACFE,IAAMC,IACJd,EAAOc,EAAK,EAEdV,MAAO,CACLgB,OAAQ,QACRM,MAAO,WACJ3B,EAAMK,Q,CCPJ,SAAAD,EAA+BJ,GAI5C,MAAOE,EAAM0B,IAAW,EAAArB,EAAAC,UAAS,KAC1BqB,EAASC,IAAc,EAAAvB,EAAAC,WAAS,IAEhCM,EAAKb,IAAU,EAAAM,EAAAC,UAAS,MAEzBuB,GAAe,EAAAxB,EAAAyB,UAAQ,KACpB,CACLC,QAASnB,E,cACToB,EACAC,OAAQnC,EAAMmC,QAAU,OAEzB,CAACrB,EAAKd,IAEHoC,GAAS,EAAA7B,EAAA8B,cAAatB,IACb,OAATA,GAAed,EAAOc,EAAK,GAC9B,IAEH,SAASmB,IACHlC,EAAME,MAAM0B,GAAQ,IAAM5B,EAAME,OACpC4B,GAAW,KAAM,G,CAYnB,OATA,EAAAvB,EAAAG,YAAU,KACI,OAARI,GAEFwB,EAAcC,WAAWR,GACpB,IAELO,EAAcE,sBAAsBT,KACrC,CAACjB,IAEG,CAACsB,EAAQlC,EAAM2B,E,6RAIxB,MAAMY,EAAW,IAAIC,IAEfJ,EAAgB,CAIpBK,aAAc,EAACR,OACbA,EAAMS,IACNA,EAAGC,KACHA,KAKID,EAAME,OAAOC,YAAcZ,GAAUU,EAAOC,OAAOE,WAAab,EAEtEc,qBAAuBC,IACrB,MAAMN,IAAEA,EAAGC,KAAEA,GAASK,EAAKjB,SAASkB,yBAA2B,CAC7DP,IAAK,EACLC,KAAM,GAGR,MAAO,IACFK,E,IACHN,E,KACAC,EACD,EAEHN,WAAY,SAAUN,GAEpBQ,EAASW,IAAInB,GAE4B,IAArCK,EAAce,qBAChBf,EAAce,mBAAqBP,OAAOQ,sBACxChB,EAAciB,c,EAIpBA,aAAc,WAEU,IAAlBd,EAASe,KACXlB,EAAcmB,uBAEdhB,EAASiB,SAASR,IACGZ,EAAcK,aAC/BL,EAAcW,qBAAqBC,MAGnCA,EAAKhB,gBAELI,EAAcE,sBAAsBU,G,IAGxCZ,EAAce,mBAAqBP,OAAOQ,sBACxChB,EAAciB,c,EAKpBE,oBAAqB,WACnBX,OAAOa,qBAAqBrB,EAAce,oBAC1Cf,EAAce,mBAAqB,C,EAGrCb,sBAAuB,SAAUoB,GAC/BnB,EAASoB,OAAOD,E,EAElBP,mBAAoB","sources":["src/lazyLoadBackgroundImage.tsx","src/lazyLoadImage.tsx","src/lazyLoadFrame.tsx","src/lazyLoadComponent.tsx","src/useIsInViewport.tsx"],"sourcesContent":["import React, { useState, useEffect } from 'react' // eslint-disable-line no-unused-vars\nimport useIsInViewPort from './index'\n\nexport default function LazyBackgroundImage(props: any) {\n const [setRef, link, isViewable] = useIsInViewPort(props)\n\n const [style, setStyle] = useState({\n backgroundImage: `url(${link})`,\n ...props.style,\n })\n\n useEffect(() => {\n setStyle({\n backgroundImage: `url(${link})`,\n ...props.style,\n })\n }, [link, isViewable])\n\n return (\n <div\n className={props.className}\n style={style}\n ref={(node) => {\n setRef(node)\n }}\n >\n {props.children}\n </div>\n )\n}\n","import React from 'react' // eslint-disable-line no-unused-vars\nimport useIsInViewPort from './index'\n\nexport default function LazyImage(props: any) {\n const [setRef, link] = useIsInViewPort(props)\n\n return (\n <div\n ref={(node) => {\n setRef(node)\n }}\n >\n <img\n src={link}\n alt={props.alt}\n style={props.style}\n className={props.className}\n />\n </div>\n )\n}\n","import React from 'react' // eslint-disable-line no-unused-vars\nimport useIsInViewPort from './index'\n\nexport default function LazyFrame(props: any) {\n const [setRef, link] = useIsInViewPort(props)\n\n return (\n <iframe\n height={props.height || '500'}\n scrolling={props.scrolling || 'no'}\n src={link}\n frameBorder={props.frameBorder || 'no'}\n allowFullScreen={props.allowFullScreen || true}\n style={props.style || {}}\n ref={(node) => {\n setRef(node)\n }}\n {...props}\n />\n )\n}\n","import React from 'react'\nimport useIsInViewport from './index'\n\nexport default function LazyComponent(props: any) {\n const [setRef, link, isVisible] = useIsInViewport(props)\n\n if (!isVisible)\n return (\n <div\n ref={(node) => {\n setRef(node)\n }}\n style={{\n height: '300px',\n width: '300px',\n ...props.style,\n }}\n ></div>\n )\n\n return <div>{props.children}</div>\n}\n","import { useState, useEffect, useMemo, useCallback } from 'react' // eslint-disable-line no-unused-vars\n\ninterface InstanceElement {\n makeItVisible: () => void\n element: HTMLElement | null\n offset: number\n}\n\nexport default function useRenderIfInViewPort(props: {\n link: string\n offset: number\n}): [Function, string, boolean] {\n const [link, setLink] = useState('')\n const [visible, setVisible] = useState(false)\n\n const [ref, setRef] = useState(null)\n\n const thisInstance = useMemo(() => {\n return {\n element: ref,\n makeItVisible,\n offset: props.offset || 100,\n }\n }, [ref, props])\n\n const getRef = useCallback((node) => {\n if (node !== null) setRef(node)\n }, [])\n\n function makeItVisible() {\n if (props.link) setLink(() => props.link)\n setVisible(() => true)\n }\n\n useEffect(() => {\n if (ref !== null)\n // add the element to the array of elements that are waiting to be lazy loaded\n CheckIfRender.addElement(thisInstance)\n return () =>\n // if the element is unloaded remove the element from the list of elements that needs to be lazy loader\n CheckIfRender.removeElementFromList(thisInstance)\n }, [ref])\n\n return [getRef, link, visible]\n}\n\n// array with all the elements that are waiting to be shown in the viewport\nconst elements = new Set<InstanceElement>()\n\nconst CheckIfRender = {\n // top: the position of the element in relation with the top of the browser\n // left: the position of the element in relation with the left of the browser\n // offset: the desired offset of the element in relation of the viewport\n isInViewPort: ({\n offset,\n top,\n left,\n }: {\n offset: number\n top: number\n left: number\n }) => top < window.innerHeight + offset && left < window.innerWidth + offset,\n\n calculateNewPosition: (elem: InstanceElement) => {\n const { top, left } = elem.element?.getBoundingClientRect() || {\n top: 0,\n left: 0,\n }\n\n return {\n ...elem,\n top,\n left,\n }\n },\n addElement: function (element: InstanceElement) {\n //the distance from the pixel 0,0 and the top of the element\n elements.add(element)\n //check if has already been started the rAF cycle\n if (CheckIfRender.isListenerAttached === 0) {\n CheckIfRender.isListenerAttached = window.requestAnimationFrame(\n CheckIfRender.eventHandler\n )\n }\n },\n eventHandler: function () {\n //if there is no more element to lazy load remove the listener/rAF\n if (elements.size === 0) {\n CheckIfRender.removeScrollHandler()\n } else {\n elements.forEach((elem) => {\n const haveToShow = CheckIfRender.isInViewPort(\n CheckIfRender.calculateNewPosition(elem)\n )\n if (haveToShow) {\n elem.makeItVisible()\n // remove element from the list of elements to lazy load\n CheckIfRender.removeElementFromList(elem)\n }\n })\n CheckIfRender.isListenerAttached = window.requestAnimationFrame(\n CheckIfRender.eventHandler\n )\n }\n },\n\n removeScrollHandler: function () {\n window.cancelAnimationFrame(CheckIfRender.isListenerAttached)\n CheckIfRender.isListenerAttached = 0\n },\n //When an element is unloaded remove it from the list of elements that are waiting to be lazy-loaded\n removeElementFromList: function (toRemove: InstanceElement) {\n elements.delete(toRemove)\n },\n isListenerAttached: 0, // intended as not set\n}\n"],"names":["$6e38eea936045ca0$export$2e2bcd8739ae039","props","setRef","link","isViewable","$03b515f3f8c77d8f$export$2e2bcd8739ae039","style","setStyle","$9w1Q4$react","useState","backgroundImage","useEffect","$9w1Q4$reactjsxruntime","jsx","className","ref","node","children","$f6f596272f209e0c$export$2e2bcd8739ae039","src","alt","$8e3d626f2d1eebd8$export$2e2bcd8739ae039","height","scrolling","frameBorder","allowFullScreen","$c17687259f8b5ddf$export$2e2bcd8739ae039","isVisible","width","setLink","visible","setVisible","thisInstance","useMemo","element","makeItVisible","offset","getRef","useCallback","$03b515f3f8c77d8f$var$CheckIfRender","addElement","removeElementFromList","$03b515f3f8c77d8f$var$elements","Set","isInViewPort","top","left","window","innerHeight","innerWidth","calculateNewPosition","elem","getBoundingClientRect","add","isListenerAttached","requestAnimationFrame","eventHandler","size","removeScrollHandler","forEach","cancelAnimationFrame","toRemove","delete"],"version":3,"file":"index.js.map"}
|
package/package.json
CHANGED
|
@@ -1,18 +1,23 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "lazy-react",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.5.0",
|
|
4
4
|
"description": "components to lazy load iframes, images and images as backgrounds",
|
|
5
|
+
"source": "./src/index.tsx",
|
|
5
6
|
"main": "./dist/index.js",
|
|
6
7
|
"scripts": {
|
|
7
|
-
"
|
|
8
|
-
"build
|
|
9
|
-
"build": "npm run build:release && npm run build:demo",
|
|
8
|
+
"start": "parcel serve ./src/demo/index.html --dist-dir ./demo",
|
|
9
|
+
"build": "parcel build",
|
|
10
10
|
"lint": "eslint src/*",
|
|
11
11
|
"lint:fix": "eslint --fix src/*",
|
|
12
12
|
"format": "prettier --write --single-quote --no-semi ./src/*.tsx",
|
|
13
13
|
"precommit": "lint-staged",
|
|
14
14
|
"test": "jest"
|
|
15
15
|
},
|
|
16
|
+
"targets": {
|
|
17
|
+
"main": {
|
|
18
|
+
"optimize": true
|
|
19
|
+
}
|
|
20
|
+
},
|
|
16
21
|
"lint-staged": {
|
|
17
22
|
"src/*.js": [
|
|
18
23
|
"prettier --write --single-quote --no-semi",
|
|
@@ -35,22 +40,20 @@
|
|
|
35
40
|
"@types/node": "^17.0.21",
|
|
36
41
|
"@types/react": "^17.0.43",
|
|
37
42
|
"@types/react-dom": "^17.0.14",
|
|
38
|
-
"eslint": "^
|
|
39
|
-
"eslint
|
|
43
|
+
"@typescript-eslint/eslint-plugin": "^5.35.1",
|
|
44
|
+
"@typescript-eslint/parser": "^5.35.1",
|
|
45
|
+
"eslint": "^7.32.0",
|
|
46
|
+
"eslint-config-prettier": "^8.5.0",
|
|
47
|
+
"eslint-plugin-react": "^7.30.1",
|
|
40
48
|
"husky": "^4.3.0",
|
|
41
49
|
"jest": "^27.5.1",
|
|
42
50
|
"lint-staged": "^10.4.0",
|
|
51
|
+
"parcel": "^2.7.0",
|
|
43
52
|
"prettier": "^2.1.2",
|
|
44
|
-
"
|
|
45
|
-
"typescript": "^4.6.2",
|
|
46
|
-
"webpack": "^5.66.0",
|
|
47
|
-
"webpack-cli": "^4.9.1"
|
|
48
|
-
},
|
|
49
|
-
"dependencies": {
|
|
50
|
-
"react": "^17.0.2",
|
|
51
|
-
"react-dom": "^17.0.2"
|
|
53
|
+
"process": "^0.11.10"
|
|
52
54
|
},
|
|
53
55
|
"peerDependencies": {
|
|
56
|
+
"react": "^17.0.2",
|
|
54
57
|
"react-dom": "^17.0.2"
|
|
55
58
|
}
|
|
56
59
|
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
|
|
3
|
+
import React from 'react'
|
|
4
|
+
import ReactDOM from 'react-dom'
|
|
5
|
+
import { LazyImage, LazyBackgroundImage, LazyFrame, LazyComponent } from '../../dist'
|
|
6
|
+
|
|
7
|
+
function Experimental (){
|
|
8
|
+
return <h1> I’m lazy loaded!</h1>
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
function Demo() {
|
|
12
|
+
return <div>
|
|
13
|
+
<h2>Just scroll down</h2>
|
|
14
|
+
<div style={{
|
|
15
|
+
minHeight: '100vh',
|
|
16
|
+
minWidth: '100vw',
|
|
17
|
+
backgroundColor: 'tomato'
|
|
18
|
+
}}></div>
|
|
19
|
+
<LazyImage
|
|
20
|
+
link={'https://images.unsplash.com/photo-1462834026679-7c03bf571a67?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=6e160dc1e65511df7bf1c461f8a93c82'}
|
|
21
|
+
offset={0}
|
|
22
|
+
/>
|
|
23
|
+
<LazyImage
|
|
24
|
+
link={'https://images.unsplash.com/5/unsplash-kitsune-4.jpg?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=44828cfc286e8eb8cd0ed2ca561f8cb9'}
|
|
25
|
+
offset={100}
|
|
26
|
+
className={'styledImage'}
|
|
27
|
+
/>
|
|
28
|
+
<LazyImage
|
|
29
|
+
link={'https://images.unsplash.com/photo-1472132858735-6313c7962473?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=f38318ed6adee6db020705bedf6d6e10'}
|
|
30
|
+
offset={100}
|
|
31
|
+
/>
|
|
32
|
+
<LazyImage
|
|
33
|
+
link={'https://images.unsplash.com/photo-1469899324414-c72bfb4d4161?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=8d708d646e3b2d32c5faf67e01919872'}
|
|
34
|
+
offset={100}
|
|
35
|
+
className={'test'}
|
|
36
|
+
preserveAspect={false}
|
|
37
|
+
/>
|
|
38
|
+
<LazyImage
|
|
39
|
+
link={'https://images.unsplash.com/photo-1462834026679-7c03bf571a67?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=6e160dc1e65511df7bf1c461f8a93c82'}
|
|
40
|
+
offset={100}
|
|
41
|
+
className={'test'}
|
|
42
|
+
preserveAspect={false}
|
|
43
|
+
/>
|
|
44
|
+
<LazyBackgroundImage
|
|
45
|
+
link={'https://images.unsplash.com/photo-1462834026679-7c03bf571a67?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=6e160dc1e65511df7bf1c461f8a93c82'}
|
|
46
|
+
className="fill"
|
|
47
|
+
/>
|
|
48
|
+
|
|
49
|
+
<LazyComponent>
|
|
50
|
+
<Experimental />
|
|
51
|
+
<Experimental />
|
|
52
|
+
<Experimental />
|
|
53
|
+
</LazyComponent>
|
|
54
|
+
|
|
55
|
+
<LazyFrame
|
|
56
|
+
link={'http://jonathanobino.xyz'}
|
|
57
|
+
scrolling={'true'}
|
|
58
|
+
/>
|
|
59
|
+
</div>
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
ReactDOM.render(<Demo/>, document.getElementById('app'))
|
|
@@ -2,7 +2,7 @@ import React, { useState, useEffect } from 'react' // eslint-disable-line no-unu
|
|
|
2
2
|
import useIsInViewPort from './index'
|
|
3
3
|
|
|
4
4
|
export default function LazyBackgroundImage(props: any) {
|
|
5
|
-
|
|
5
|
+
const [setRef, link, isViewable] = useIsInViewPort(props)
|
|
6
6
|
|
|
7
7
|
const [style, setStyle] = useState({
|
|
8
8
|
backgroundImage: `url(${link})`,
|
package/src/lazyLoadFrame.tsx
CHANGED
|
@@ -2,7 +2,7 @@ import React from 'react' // eslint-disable-line no-unused-vars
|
|
|
2
2
|
import useIsInViewPort from './index'
|
|
3
3
|
|
|
4
4
|
export default function LazyFrame(props: any) {
|
|
5
|
-
|
|
5
|
+
const [setRef, link] = useIsInViewPort(props)
|
|
6
6
|
|
|
7
7
|
return (
|
|
8
8
|
<iframe
|
package/src/useIsInViewport.tsx
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { useState, useEffect, useMemo, useCallback } from 'react' // eslint-disable-line no-unused-vars
|
|
2
2
|
|
|
3
3
|
interface InstanceElement {
|
|
4
4
|
makeItVisible: () => void
|
|
@@ -13,7 +13,7 @@ export default function useRenderIfInViewPort(props: {
|
|
|
13
13
|
const [link, setLink] = useState('')
|
|
14
14
|
const [visible, setVisible] = useState(false)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
const [ref, setRef] = useState(null)
|
|
17
17
|
|
|
18
18
|
const thisInstance = useMemo(() => {
|
|
19
19
|
return {
|
|
@@ -28,8 +28,7 @@ export default function useRenderIfInViewPort(props: {
|
|
|
28
28
|
}, [])
|
|
29
29
|
|
|
30
30
|
function makeItVisible() {
|
|
31
|
-
if(props.link)
|
|
32
|
-
setLink(() => props.link)
|
|
31
|
+
if (props.link) setLink(() => props.link)
|
|
33
32
|
setVisible(() => true)
|
|
34
33
|
}
|
|
35
34
|
|
|
@@ -46,7 +45,7 @@ export default function useRenderIfInViewPort(props: {
|
|
|
46
45
|
}
|
|
47
46
|
|
|
48
47
|
// array with all the elements that are waiting to be shown in the viewport
|
|
49
|
-
|
|
48
|
+
const elements = new Set<InstanceElement>()
|
|
50
49
|
|
|
51
50
|
const CheckIfRender = {
|
|
52
51
|
// top: the position of the element in relation with the top of the browser
|
|
@@ -76,7 +75,7 @@ const CheckIfRender = {
|
|
|
76
75
|
},
|
|
77
76
|
addElement: function (element: InstanceElement) {
|
|
78
77
|
//the distance from the pixel 0,0 and the top of the element
|
|
79
|
-
elements.
|
|
78
|
+
elements.add(element)
|
|
80
79
|
//check if has already been started the rAF cycle
|
|
81
80
|
if (CheckIfRender.isListenerAttached === 0) {
|
|
82
81
|
CheckIfRender.isListenerAttached = window.requestAnimationFrame(
|
|
@@ -86,10 +85,10 @@ const CheckIfRender = {
|
|
|
86
85
|
},
|
|
87
86
|
eventHandler: function () {
|
|
88
87
|
//if there is no more element to lazy load remove the listener/rAF
|
|
89
|
-
if (elements.
|
|
88
|
+
if (elements.size === 0) {
|
|
90
89
|
CheckIfRender.removeScrollHandler()
|
|
91
90
|
} else {
|
|
92
|
-
elements.forEach((elem
|
|
91
|
+
elements.forEach((elem) => {
|
|
93
92
|
const haveToShow = CheckIfRender.isInViewPort(
|
|
94
93
|
CheckIfRender.calculateNewPosition(elem)
|
|
95
94
|
)
|
|
@@ -111,9 +110,7 @@ const CheckIfRender = {
|
|
|
111
110
|
},
|
|
112
111
|
//When an element is unloaded remove it from the list of elements that are waiting to be lazy-loaded
|
|
113
112
|
removeElementFromList: function (toRemove: InstanceElement) {
|
|
114
|
-
elements
|
|
113
|
+
elements.delete(toRemove)
|
|
115
114
|
},
|
|
116
115
|
isListenerAttached: 0, // intended as not set
|
|
117
116
|
}
|
|
118
|
-
|
|
119
|
-
export { CheckIfRender }
|
package/demo/demo.js
DELETED
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
import React, {Component} from 'react'
|
|
2
|
-
import ReactDOM from 'react-dom'
|
|
3
|
-
import {LazyImage, LazyBackgroundImage, LazyFrame, LazyComponent} from '../dist'
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
function Experimental (props){
|
|
7
|
-
return <h1> I'm lazy loaded!</h1>
|
|
8
|
-
}
|
|
9
|
-
|
|
10
|
-
class Demo extends Component {
|
|
11
|
-
constructor(props) {
|
|
12
|
-
super(props)
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
render() {
|
|
16
|
-
let style = {
|
|
17
|
-
minHeight:'100vh'
|
|
18
|
-
}
|
|
19
|
-
return <div>
|
|
20
|
-
<h2>Just scroll</h2>
|
|
21
|
-
<div style={{
|
|
22
|
-
minHeight: '100vh',
|
|
23
|
-
minWidth: '100vw',
|
|
24
|
-
backgroundColor: 'tomato'
|
|
25
|
-
}}></div>
|
|
26
|
-
<LazyImage
|
|
27
|
-
link={'https://images.unsplash.com/photo-1462834026679-7c03bf571a67?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=6e160dc1e65511df7bf1c461f8a93c82'}
|
|
28
|
-
offset={0}
|
|
29
|
-
/>
|
|
30
|
-
<LazyImage
|
|
31
|
-
link={'https://images.unsplash.com/5/unsplash-kitsune-4.jpg?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=44828cfc286e8eb8cd0ed2ca561f8cb9'}
|
|
32
|
-
offset={100}
|
|
33
|
-
className={'styledImage'}
|
|
34
|
-
/>
|
|
35
|
-
<LazyImage
|
|
36
|
-
link={'https://images.unsplash.com/photo-1472132858735-6313c7962473?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=f38318ed6adee6db020705bedf6d6e10'}
|
|
37
|
-
offset={100}
|
|
38
|
-
/>
|
|
39
|
-
<LazyImage
|
|
40
|
-
link={'https://images.unsplash.com/photo-1469899324414-c72bfb4d4161?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=8d708d646e3b2d32c5faf67e01919872'}
|
|
41
|
-
offset={100}
|
|
42
|
-
className={'test'}
|
|
43
|
-
preserveAspect={false}
|
|
44
|
-
/>
|
|
45
|
-
<LazyImage
|
|
46
|
-
link={'https://images.unsplash.com/photo-1462834026679-7c03bf571a67?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=6e160dc1e65511df7bf1c461f8a93c82'}
|
|
47
|
-
offset={100}
|
|
48
|
-
className={'test'}
|
|
49
|
-
preserveAspect={false}
|
|
50
|
-
/>
|
|
51
|
-
<LazyBackgroundImage
|
|
52
|
-
link={'https://images.unsplash.com/photo-1462834026679-7c03bf571a67?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&s=6e160dc1e65511df7bf1c461f8a93c82'}
|
|
53
|
-
className="fill"
|
|
54
|
-
/>
|
|
55
|
-
|
|
56
|
-
<LazyComponent>
|
|
57
|
-
<Experimental />
|
|
58
|
-
<Experimental />
|
|
59
|
-
<Experimental />
|
|
60
|
-
</LazyComponent>
|
|
61
|
-
|
|
62
|
-
<LazyFrame
|
|
63
|
-
link={'http://jonathanobino.xyz'}
|
|
64
|
-
scrolling={'true'}
|
|
65
|
-
/>
|
|
66
|
-
</div>
|
|
67
|
-
}
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
ReactDOM.render(<Demo/>,document.getElementById('app'))
|