r-sticky
v1.0.6
Published
make component sticky
Downloads
1
Readme
Sticky 粘在屏幕上
让你的组件具有粘性
概览 & 实例
Sticky
的目标是让各位开发者更容易构建出充满粘性的 UI 组件,一些例子里会有粘性的导航栏,或者双列布局中左侧粘性右侧滚动。
Stikcy
的原理是通过计算与<StickyContainer>
组件相对应的<Sticky>
的位置来产生粘性,如果这个位置会超出可见范围,它会同通过 renderCallback 的形式以 styles 作为一个参数,让元素粘在屏幕的顶部。
<StickyContainer>
<Sticky>{({ style }) => <h1 style={style}>Sticky element</h1>}</Sticky>
</StickyContainer>
主要的使用方式只需要通过 style 传递给 DOM,还是还是提供了一些额外的属性用于更高级的用例:
render 入参
style
(object) - 可选修改 Style 的参数,大部分场景下只需要这个属性.isSticky
(boolean) - 是否当前元素需要具有粘性wasSticky
(boolean) - 是否当前元素需要曾经具有粘性?distanceFromTop
(number) -Sticky
的顶部距离StickyContainer
'的顶部距离,单位像素 pxdistanceFromBottom
(number) -Sticky
的底部距离StickyContainer
'的底部距离,单位像素 pxcalculatedHeight
(number) - renderProps 所返回的元素的高度
在StickyContainer
事件触发的时候,Sticky
的子节点函数会被调用,并且通过你自己的逻辑跟定制发挥作用,伴随这一个聪明的 style 属性帮助你快速开发。
完整实例
Here's an example of all of those pieces together: 这里是一个完整的例子,包含了所有组成。 app.js
import React from 'react';
import { StickyContainer, Sticky } from 'r-sticky';
// ...
class App extends React.Component {
render() {
return (
<StickyContainer>
{/* Other elements can be in between `StickyContainer` and `Sticky`,
but certain styles can break the positioning logic used. */}
<Sticky>
{({
style,
// the following are also available but unused in this example
isSticky,
wasSticky,
distanceFromTop,
distanceFromBottom,
calculatedHeight
}) => (
<header style={style}>
{/* ... */}
</header>
)}
</Sticky>
{/* ... */}
</StickyContainer>
);
},
};
当粘性被激活的时候,传递给 sticky 的函数参数也会变化,与之相对应的,粘性被关闭时也会变化。
<StickyContainer />
Props
<StickyContainer />
支持所有有效的 <div />
props.
<Sticky />
Props
relative (default: false)
当<StickyContainer />
会滚动 overflow 时,所包含的<Sticky />
元素应该设定relative
为true
,并且你希望对应<Sticky />
只会对这个 container 的事件做出反应。
在relative
模式中,window
的事件不会触发粘性的状态改变,只有在对应的 container 的滚动事件会触发粘性状态的改变。
topOffset (default: 0)
当对应的 Sticky 组件顶部跟对应<StickyContainer />
的顶部的距离等于topOffet
时,sticky 的状态被激活。正整数是一个懒激活状态,而负数更符合直觉。
app.js
<StickyContainer>
...
<Sticky topOffset={80}>
{ props => (...) }
</Sticky>
...
</StickyContainer>
上述例子会在Sticky
组件的顶部**超出**<StickyContainer />
80px 时候触发粘性状态。
bottomOffset (default: 0)
当元素的底部距离最近的<StickyContainer />
的底部等于bottomOffset
时,粘性会被激活。
app.js
<StickyContainer>
...
<Sticky bottomOffset={80}>
{ props => (...) }
</Sticky>
...
</StickyContainer>
The above would result in an element that ceases to be sticky once its bottom is 80px away from the bottom of the <StickyContainer />
.
disableCompensation (default: false)
Set disableCompensation
to true
如果你不希望你的 sticky 组件通过添加一个 padding 到 Placeholder 来避免切换position:fixed
的跳动,设置为 true
app.js
<StickyContainer>
...
<Sticky disableCompensation>
{ props => (...) }
</Sticky>
...
</StickyContainer>
disableHardwareAcceleration (default: false)
当disableHardwareAcceleration
被设定为 true 时,对应<Sticky />
元素不会使用硬件加速transfrom: translateZ(0)
,因为它会在移动端体验上的副作用,不推荐开启这项功能,通常能够通过优化 DOM 结构解决。
app.js
<StickyContainer>
...
<Sticky disableHardwareAcceleration>
{ props => (...) }
</Sticky>
...
</StickyContainer>
Hooks 钩子
useSticky
订阅最近的 StickyContainer 的事件
- scroll
- wheel
- touchmove/touchstart/touchend
- pageshow
- load
sticky 钩子函数,用于监听最近的一个 StickContainer 的事件,回调函数参数与上述传参一致
Demo
const MyComponent: React.FC = () => {
const [isSticky, setIsSticky] = useState(false);
const handleContainerEvent = useCallback(
({ eventSource }) => {
if (eventSource === document.body) return;
setIsSticky(eventSource.scrollTop >= 200);
},
[isSticky]
);
useSticky(handleContainerEvent);
const text = useMemo(() => (isSticky ? "吸顶" : "不吸顶"), [isSticky]);
const classname = useMemo(
() => mergeStr({ "my-page__nav": true, "is-sticky": isSticky }),
[isSticky]
);
return <div className={classname}>{text}</div>;
};
提示
transplanted from react-sticky