Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions packages/mui-material/src/useScrollTrigger/useScrollTrigger.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,31 @@ const defaultTarget = typeof window !== 'undefined' ? window : null;
export default function useScrollTrigger(options = {}) {
const { getTrigger = defaultTrigger, target = defaultTarget, ...other } = options;
const store = React.useRef();
const ticking = React.useRef(false);
const [trigger, setTrigger] = React.useState(() => getTrigger(store, other));
React.useEffect(() => {
if (target === null) {
return setTrigger(false);
}

let rafID = null;
const handleScroll = () => {
setTrigger(getTrigger(store, { target, ...other }));
if (!ticking.current) {
ticking.current = true;
rafID = window.requestAnimationFrame(() => {
setTrigger(getTrigger(store, { target, ...other }));
ticking.current = false;
});
}
};

handleScroll(); // Re-evaluate trigger when dependencies change
setTrigger(getTrigger(store, { target, ...other })); // Re-evaluate trigger when dependencies change
target.addEventListener('scroll', handleScroll, { passive: true });
return () => {
target.removeEventListener('scroll', handleScroll, { passive: true });
if (rafID) {
window.cancelAnimationFrame(rafID);
}
};
// See Option 3. https://github.com/facebook/react/issues/14476#issuecomment-471199055
// TODO: uncomment once we enable eslint-plugin-react-compiler // eslint-disable-next-line react-compiler/react-compiler
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as React from 'react';
import PropTypes from 'prop-types';
import { expect } from 'chai';
import { stub } from 'sinon';
import { act, createRenderer, RenderCounter, screen } from '@mui/internal-test-utils';
import describeSkipIf from '@mui/internal-test-utils/describeSkipIf';
import useScrollTrigger from '@mui/material/useScrollTrigger';
Expand All @@ -9,6 +10,21 @@ import Box from '@mui/material/Box';

describe('useScrollTrigger', () => {
const { render } = createRenderer();
let requestAnimationFrameStub;
let cancelAnimationFrameStub;

beforeEach(() => {
requestAnimationFrameStub = stub(window, 'requestAnimationFrame').callsFake((callback) => {
callback(0);
return 0;
});
cancelAnimationFrameStub = stub(window, 'cancelAnimationFrame');
});

afterEach(() => {
requestAnimationFrameStub.restore();
cancelAnimationFrameStub.restore();
});

describe('defaultTrigger', () => {
it('should be false by default', () => {
Expand Down
Loading