react-sticky-kit 0.1.3 → 0.1.4

package/README.md

@@ -40,7 +40,9 @@ pnpm add react-sticky-kit
 
 ```tsx
 import { StickyContainer, StickyItem } from 'react-sticky-kit';
-import 'react-sticky-kit/dist/style.css'; // Import styles for sticky components
+// !! Import styles for sticky components
+import 'react-sticky-kit/dist/style.css';
+// or `import 'react-sticky-kit/style';` for more clean style path(require modern bundler tools)
 
 export default function Example() {
   return (

package/dist/react-sticky.es.js

@@ -1,61 +1,60 @@
 import { jsx as R } from "react/jsx-runtime";
 import { createContext as b, useContext as Z, useRef as I, useState as N, useEffect as B, useCallback as w, useMemo as T } from "react";
-const x = 20, $ = b(null);
-function _() {
+const x = 20, _ = 200, $ = b(null);
+function L() {
   return Z($);
 }
-function P({ mode: s, children: o, className: m, ...h }) {
-  const e = _(), S = I(null), k = I(null), [r, n] = N(!1), t = I({
+function M({ mode: s, children: o, className: y, ...h }) {
+  const e = L(), S = I(null), k = I(null), [r, n] = N(!1), t = I({
     fixedOffsetTop: (e == null ? void 0 : e.fixedOffsetTop) || 0,
     isSticky: r,
     baseZIndex: (e == null ? void 0 : e.baseZIndex) || x
   });
   return t.current.baseZIndex = (e == null ? void 0 : e.baseZIndex) || x, t.current.fixedOffsetTop = (e == null ? void 0 : e.fixedOffsetTop) || 0, t.current.isSticky = r, B(() => {
-    const u = k.current, f = S.current, a = s || (e == null ? void 0 : e.mode);
-    if (!e || !f || !u || a === "none" || !a || !e.register) {
+    const u = k.current, f = S.current, d = s || (e == null ? void 0 : e.mode);
+    if (!e || !f || !u || d === "none" || !d || !e.register) {
       n(!1);
       return;
     }
-    const d = {
+    const a = {
       el: f,
       update: (l, i, p, C, H) => {
         if (!l)
           return t.current.isSticky && n(!1), 0;
         if (i <= p) {
-          const y = u.getBoundingClientRect().height;
+          const g = u.getBoundingClientRect().height;
           let v = p;
-          if (a === "replace" && typeof C < "u") {
-            const g = C - (p + y);
-            if (g < 0 && (v = p + g, g + y < 0))
+          if (d === "replace" && typeof C < "u") {
+            const m = C - (p + g);
+            if (m < 0 && (v = p + m, m + g < 0))
               return t.current.isSticky && n(!1), 0;
           }
-          return t.current.isSticky || n(!0), u.style.top = `${v}px`, u.style.width = `${f.offsetWidth}px`, u.style.zIndex = `${t.current.baseZIndex + (a === "replace" ? -H : H)}`, f.style.height = `${y}px`, a === "replace" ? 0 : y;
+          return t.current.isSticky || n(!0), u.style.top = `${v}px`, u.style.width = `${f.offsetWidth}px`, u.style.zIndex = `${t.current.baseZIndex + (d === "replace" ? -H : H)}`, f.style.height = `${g}px`, d === "replace" ? 0 : g;
         } else
           n(!1);
         return 0;
       }
     };
-    return e.register(d);
+    return e.register(a);
   }, [e == null ? void 0 : e.mode, e == null ? void 0 : e.register, s]), B(() => {
-    const u = S.current, f = k.current, a = e == null ? void 0 : e.updateStickyItemsHeight;
-    if (!r || !u || !f || !a)
+    const u = S.current, f = k.current, d = e == null ? void 0 : e.updateStickyItemsHeight;
+    if (!r || !u || !f || !d)
       return;
-    const c = a(f.getBoundingClientRect().height);
+    const c = d(f.getBoundingClientRect().height);
     return () => {
       O(u, ["height"]), O(f, ["top", "z-index", "width"]), c();
     };
-  }, [r, e == null ? void 0 : e.updateStickyItemsHeight]), /* @__PURE__ */ R("div", { className: "oe-sticky-item " + (m || ""), ...h, ref: S, children: /* @__PURE__ */ R("div", { className: "oe-sticky-content " + (r ? "is-sticky" : ""), ref: k, children: o }) });
+  }, [r, e == null ? void 0 : e.updateStickyItemsHeight]), /* @__PURE__ */ R("div", { className: "oe-sticky-item " + (y || ""), ...h, ref: S, children: /* @__PURE__ */ R("div", { className: "oe-sticky-content " + (r ? "is-sticky" : ""), ref: k, children: o }) });
 }
 function O(s, o) {
-  o.forEach((m) => {
-    s.style.removeProperty(m);
+  o.forEach((y) => {
+    s.style.removeProperty(y);
   });
 }
-const L = 200;
-function U({
+function P({
   children: s,
   offsetTop: o = 0,
-  baseZIndex: m,
+  baseZIndex: y,
   onStickyItemsHeightChange: h,
   defaultMode: e = "replace",
   ...S
@@ -71,18 +70,18 @@ function U({
     const c = k.current;
     if (!c)
       return;
-    const d = c.getBoundingClientRect(), l = n.current, i = l.fixedOffsetTop, p = l.stickyItemsHeight, C = !(d.top > i || d.bottom < i);
-    let H = i, y = d.bottom - (i + p);
-    y > 0 && (y = 0);
-    const v = r.current.map((g) => g.el.getBoundingClientRect().top);
-    r.current.forEach((g, E) => {
-      H += g.update(C, v[E], H + y, v[E + 1], E);
+    const a = c.getBoundingClientRect(), l = n.current, i = l.fixedOffsetTop, p = l.stickyItemsHeight, C = !(a.top > i || a.bottom < i);
+    let H = i, g = a.bottom - (i + p);
+    g > 0 && (g = 0);
+    const v = r.current.map((m) => m.el.getBoundingClientRect().top);
+    r.current.forEach((m, E) => {
+      H += m.update(C, v[E], H + g, v[E + 1], E);
     });
   }, []), u = w((c) => {
-    const d = n.current.stickyItemsHeight + c;
-    return n.current.stickyItemsHeight = d, setTimeout(() => {
+    const a = n.current.stickyItemsHeight + c;
+    return n.current.stickyItemsHeight = a, setTimeout(() => {
       var l, i;
-      (i = (l = n.current).onStickyItemsHeightChange) == null || i.call(l, d);
+      (i = (l = n.current).onStickyItemsHeightChange) == null || i.call(l, a);
     }, 0), () => {
       const l = n.current.stickyItemsHeight - c;
       n.current.stickyItemsHeight = l, setTimeout(() => {
@@ -95,18 +94,18 @@ function U({
     n.current.fixedOffsetTop = o, n.current.defaultMode = e, t();
   }, [o, e, t]);
   const f = w((c) => (r.current.push(c), r.current = A(r.current), t(), () => {
-    r.current = r.current.filter((d) => d !== c), t();
+    r.current = r.current.filter((a) => a !== c), t();
   }), [t]);
   B(() => (window.addEventListener("scroll", t, { passive: !0 }), window.addEventListener("resize", t, { passive: !0 }), () => {
     window.removeEventListener("scroll", t), window.removeEventListener("resize", t);
   }), [t]);
-  const a = T(() => z(m), [m]);
+  const d = T(() => z(y), [y]);
   return /* @__PURE__ */ R(
     $.Provider,
     {
       value: {
         register: f,
-        baseZIndex: a,
+        baseZIndex: d,
         updateStickyItemsHeight: u,
         fixedOffsetTop: o,
         mode: e
@@ -117,7 +116,6 @@ function U({
           ...S,
           ref: k,
           className: "oe-sticky-container",
-          "data-mode": e,
           children: s
         }
       )
@@ -125,15 +123,15 @@ function U({
   );
 }
 function z(s) {
-  return typeof s > "u" ? L : Math.max(Number(s) || 0, x);
+  return typeof s > "u" ? _ : Math.max(Number(s) || 0, x);
 }
 function A(s) {
-  return s.sort((o, m) => {
-    const h = o.el.getBoundingClientRect(), e = m.el.getBoundingClientRect();
+  return s.sort((o, y) => {
+    const h = o.el.getBoundingClientRect(), e = y.el.getBoundingClientRect();
     return h.top - e.top;
   });
 }
 export {
-  U as StickyContainer,
-  P as StickyItem
+  P as StickyContainer,
+  M as StickyItem
 };

package/dist/react-sticky.umd.js

@@ -1 +1 @@
-(function(p,m){typeof exports=="object"&&typeof module<"u"?m(exports,require("react/jsx-runtime"),require("react")):typeof define=="function"&&define.amd?define(["exports","react/jsx-runtime","react"],m):(p=typeof globalThis<"u"?globalThis:p||self,m(p.ReactSticky={},p.jsxRuntime,p.React))})(this,function(p,m,n){"use strict";const _=n.createContext(null);function N(){return n.useContext(_)}const A="";function O({mode:c,children:o,className:g,...S}){const e=N(),R=n.useRef(null),E=n.useRef(null),[s,i]=n.useState(!1),t=n.useRef({fixedOffsetTop:(e==null?void 0:e.fixedOffsetTop)||0,isSticky:s,baseZIndex:(e==null?void 0:e.baseZIndex)||20});return t.current.baseZIndex=(e==null?void 0:e.baseZIndex)||20,t.current.fixedOffsetTop=(e==null?void 0:e.fixedOffsetTop)||0,t.current.isSticky=s,n.useEffect(()=>{const f=E.current,d=R.current,l=c||(e==null?void 0:e.mode);if(!e||!d||!f||l==="none"||!l||!e.register){i(!1);return}const a={el:d,update:(y,r,h,v,H)=>{if(!y)return t.current.isSticky&&i(!1),0;if(r<=h){const k=f.getBoundingClientRect().height;let C=h;if(l==="replace"&&typeof v<"u"){const I=v-(h+k);if(I<0&&(C=h+I,I+k<0))return t.current.isSticky&&i(!1),0}return t.current.isSticky||i(!0),f.style.top=`${C}px`,f.style.width=`${d.offsetWidth}px`,f.style.zIndex=`${t.current.baseZIndex+(l==="replace"?-H:H)}`,d.style.height=`${k}px`,l==="replace"?0:k}else i(!1);return 0}};return e.register(a)},[e==null?void 0:e.mode,e==null?void 0:e.register,c]),n.useEffect(()=>{const f=R.current,d=E.current,l=e==null?void 0:e.updateStickyItemsHeight;if(!s||!f||!d||!l)return;const u=l(d.getBoundingClientRect().height);return()=>{x(f,["height"]),x(d,["top","z-index","width"]),u()}},[s,e==null?void 0:e.updateStickyItemsHeight]),m.jsx("div",{className:"oe-sticky-item "+(g||""),...S,ref:R,children:m.jsx("div",{className:"oe-sticky-content "+(s?"is-sticky":""),ref:E,children:o})})}function x(c,o){o.forEach(g=>{c.style.removeProperty(g)})}const b=200;function w({children:c,offsetTop:o=0,baseZIndex:g,onStickyItemsHeightChange:S,defaultMode:e="replace",...R}){const E=n.useRef(null),s=n.useRef([]),i=n.useRef({fixedOffsetTop:o,defaultMode:e,stickyItemsHeight:0,onStickyItemsHeightChange:S});i.current.onStickyItemsHeightChange=S;const t=n.useCallback(()=>{const u=E.current;if(!u)return;const a=u.getBoundingClientRect(),y=i.current,r=y.fixedOffsetTop,h=y.stickyItemsHeight,v=!(a.top>r||a.bottom<r);let H=r,k=a.bottom-(r+h);k>0&&(k=0);const C=s.current.map(I=>I.el.getBoundingClientRect().top);s.current.forEach((I,B)=>{H+=I.update(v,C[B],H+k,C[B+1],B)})},[]),f=n.useCallback(u=>{const a=i.current.stickyItemsHeight+u;return i.current.stickyItemsHeight=a,setTimeout(()=>{var y,r;(r=(y=i.current).onStickyItemsHeightChange)==null||r.call(y,a)},0),()=>{const y=i.current.stickyItemsHeight-u;i.current.stickyItemsHeight=y,setTimeout(()=>{var r,h;(h=(r=i.current).onStickyItemsHeightChange)==null||h.call(r,y)},0)}},[]);n.useEffect(()=>{i.current.fixedOffsetTop=o,i.current.defaultMode=e,t()},[o,e,t]);const d=n.useCallback(u=>(s.current.push(u),s.current=T(s.current),t(),()=>{s.current=s.current.filter(a=>a!==u),t()}),[t]);n.useEffect(()=>(window.addEventListener("scroll",t,{passive:!0}),window.addEventListener("resize",t,{passive:!0}),()=>{window.removeEventListener("scroll",t),window.removeEventListener("resize",t)}),[t]);const l=n.useMemo(()=>Z(g),[g]);return m.jsx(_.Provider,{value:{register:d,baseZIndex:l,updateStickyItemsHeight:f,fixedOffsetTop:o,mode:e},children:m.jsx("div",{...R,ref:E,className:"oe-sticky-container","data-mode":e,children:c})})}function Z(c){return typeof c>"u"?b:Math.max(Number(c)||0,20)}function T(c){return c.sort((o,g)=>{const S=o.el.getBoundingClientRect(),e=g.el.getBoundingClientRect();return S.top-e.top})}p.StickyContainer=w,p.StickyItem=O,Object.defineProperty(p,Symbol.toStringTag,{value:"Module"})});
+(function(p,g){typeof exports=="object"&&typeof module<"u"?g(exports,require("react/jsx-runtime"),require("react")):typeof define=="function"&&define.amd?define(["exports","react/jsx-runtime","react"],g):(p=typeof globalThis<"u"?globalThis:p||self,g(p.ReactSticky={},p.jsxRuntime,p.React))})(this,function(p,g,n){"use strict";const B=n.createContext(null);function N(){return n.useContext(B)}const $="";function O({mode:c,children:o,className:m,...S}){const e=N(),R=n.useRef(null),E=n.useRef(null),[s,i]=n.useState(!1),t=n.useRef({fixedOffsetTop:(e==null?void 0:e.fixedOffsetTop)||0,isSticky:s,baseZIndex:(e==null?void 0:e.baseZIndex)||20});return t.current.baseZIndex=(e==null?void 0:e.baseZIndex)||20,t.current.fixedOffsetTop=(e==null?void 0:e.fixedOffsetTop)||0,t.current.isSticky=s,n.useEffect(()=>{const f=E.current,d=R.current,l=c||(e==null?void 0:e.mode);if(!e||!d||!f||l==="none"||!l||!e.register){i(!1);return}const y={el:d,update:(a,r,h,C,H)=>{if(!a)return t.current.isSticky&&i(!1),0;if(r<=h){const I=f.getBoundingClientRect().height;let _=h;if(l==="replace"&&typeof C<"u"){const k=C-(h+I);if(k<0&&(_=h+k,k+I<0))return t.current.isSticky&&i(!1),0}return t.current.isSticky||i(!0),f.style.top=`${_}px`,f.style.width=`${d.offsetWidth}px`,f.style.zIndex=`${t.current.baseZIndex+(l==="replace"?-H:H)}`,d.style.height=`${I}px`,l==="replace"?0:I}else i(!1);return 0}};return e.register(y)},[e==null?void 0:e.mode,e==null?void 0:e.register,c]),n.useEffect(()=>{const f=R.current,d=E.current,l=e==null?void 0:e.updateStickyItemsHeight;if(!s||!f||!d||!l)return;const u=l(d.getBoundingClientRect().height);return()=>{x(f,["height"]),x(d,["top","z-index","width"]),u()}},[s,e==null?void 0:e.updateStickyItemsHeight]),g.jsx("div",{className:"oe-sticky-item "+(m||""),...S,ref:R,children:g.jsx("div",{className:"oe-sticky-content "+(s?"is-sticky":""),ref:E,children:o})})}function x(c,o){o.forEach(m=>{c.style.removeProperty(m)})}function Z({children:c,offsetTop:o=0,baseZIndex:m,onStickyItemsHeightChange:S,defaultMode:e="replace",...R}){const E=n.useRef(null),s=n.useRef([]),i=n.useRef({fixedOffsetTop:o,defaultMode:e,stickyItemsHeight:0,onStickyItemsHeightChange:S});i.current.onStickyItemsHeightChange=S;const t=n.useCallback(()=>{const u=E.current;if(!u)return;const y=u.getBoundingClientRect(),a=i.current,r=a.fixedOffsetTop,h=a.stickyItemsHeight,C=!(y.top>r||y.bottom<r);let H=r,I=y.bottom-(r+h);I>0&&(I=0);const _=s.current.map(k=>k.el.getBoundingClientRect().top);s.current.forEach((k,v)=>{H+=k.update(C,_[v],H+I,_[v+1],v)})},[]),f=n.useCallback(u=>{const y=i.current.stickyItemsHeight+u;return i.current.stickyItemsHeight=y,setTimeout(()=>{var a,r;(r=(a=i.current).onStickyItemsHeightChange)==null||r.call(a,y)},0),()=>{const a=i.current.stickyItemsHeight-u;i.current.stickyItemsHeight=a,setTimeout(()=>{var r,h;(h=(r=i.current).onStickyItemsHeightChange)==null||h.call(r,a)},0)}},[]);n.useEffect(()=>{i.current.fixedOffsetTop=o,i.current.defaultMode=e,t()},[o,e,t]);const d=n.useCallback(u=>(s.current.push(u),s.current=w(s.current),t(),()=>{s.current=s.current.filter(y=>y!==u),t()}),[t]);n.useEffect(()=>(window.addEventListener("scroll",t,{passive:!0}),window.addEventListener("resize",t,{passive:!0}),()=>{window.removeEventListener("scroll",t),window.removeEventListener("resize",t)}),[t]);const l=n.useMemo(()=>b(m),[m]);return g.jsx(B.Provider,{value:{register:d,baseZIndex:l,updateStickyItemsHeight:f,fixedOffsetTop:o,mode:e},children:g.jsx("div",{...R,ref:E,className:"oe-sticky-container",children:c})})}function b(c){return typeof c>"u"?200:Math.max(Number(c)||0,20)}function w(c){return c.sort((o,m)=>{const S=o.el.getBoundingClientRect(),e=m.el.getBoundingClientRect();return S.top-e.top})}p.StickyContainer=Z,p.StickyItem=O,Object.defineProperty(p,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-sticky-kit",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "type": "module",
   "description": "A lightweight, flexible React sticky container and item component library supporting multiple sticky modes, advanced layouts, and edge cases.",
   "keywords": [
@@ -39,7 +39,9 @@
       "import": "./dist/react-sticky.es.js",
       "require": "./dist/react-sticky.umd.js",
       "types": "./dist/index.d.ts"
-    }
+    },
+    "./style": "./dist/style.css",
+    "./dist/style.css": "./dist/style.css"
   },
   "peerDependencies": {
     "react": ">=17.0.0",