useSticky ​
browser
test coverage
Last changed: 15 days ago
Hook that allows you to detect that your sticky component is stuck
typescript
import { useSticky } from '@siberiacancode/reactuse';
Usage ​
typescript
const stuck = useSticky(ref);
// or
const { stuck, ref } = useSticky();
Demo ​
Api ​
Parameters
Name | Type | Default | Note |
---|---|---|---|
target | HookTarget | - | The target sticky element |
options.axis? | UseStickyAxis | 'vertical' | The axis of motion of the sticky component |
options.root? | UseStickyRoot | document | The element that contains your sticky component |
Returns
Parameters
Name | Type | Default | Note |
---|---|---|---|
options.axis? | UseStickyAxis | 'vertical' | The axis of motion of the sticky component |
options.root? | UseStickyRoot | document | The element that contains your sticky component |