commit f97bee34b9bdf90eebb8150830d40f62aa076ba3 · kitten.sh/use-interactions

+93

src/__tests__/useScrollRestoration.test.tsx

···

       1
       1
       +
       import React, { useState, useRef } from 'react';

     

       2
       2
       +
       import { mount } from '@cypress/react';

     

       3
       3
       +
       import { useScrollRestoration } from '../useScrollRestoration';

     

       4
       4
       +
       

     

       5
       5
       +
       it('remembers scroll states and restores scrolls on navigation', () => {

     

       6
       6
       +
         const Main = () => {

     

       7
       7
       +
           const [showBlock, setShowBlock] = useState(false);

     

       8
       8
       +
           const ref = useRef<HTMLDivElement>(null);

     

       9
       9
       +
           useScrollRestoration(ref);

     

       10
       10
       +
       

     

       11
       11
       +
           return (

     

       12
       12
       +
             <div

     

       13
       13
       +
               id="container"

     

       14
       14
       +
               style={{ border: '1px solid red', overflowY: 'scroll', maxHeight: 100 }}

     

       15
       15
       +
               ref={ref}

     

       16
       16
       +
             >

     

       17
       17
       +
               <div style={{ height: 400 }}>block #1</div>

     

       18
       18
       +
               <button id="extend" onClick={() => setShowBlock(x => !x)}>Show Block</button>

     

       19
       19
       +
               {showBlock && <div style={{ height: 400 }}>block #2</div>}

     

       20
       20
       +
             </div>

     

       21
       21
       +
           );

     

       22
       22
       +
         };

     

       23
       23
       +
       

     

       24
       24
       +
         cy.window().then(window => {

     

       25
       25
       +
           window.history.pushState({}, '', '' + window.location);

     

       26
       26
       +
         });

     

       27
       27
       +
       

     

       28
       28
       +
         mount(<Main />);

     

       29
       29
       +
       

     

       30
       30
       +
         cy.get('#extend').realClick();

     

       31
       31
       +
         cy.get('#container').scrollTo('bottom');

     

       32
       32
       +
         cy.get('#container').trigger('scroll');

     

       33
       33
       +
       

     

       34
       34
       +
         cy.window().then(window => {

     

       35
       35
       +
           window.history.pushState({}, '', '' + window.location + '?test');

     

       36
       36
       +
         });

     

       37
       37
       +
       

     

       38
       38
       +
         cy.get('#container').invoke('scrollTop').should('not.equal', 0);

     

       39
       39
       +
         cy.get('#container').scrollTo('top');

     

       40
       40
       +
       

     

       41
       41
       +
         cy.window().then(window => {

     

       42
       42
       +
           window.history.back();

     

       43
       43
       +
         });

     

       44
       44
       +
       

     

       45
       45
       +
         cy.get('#container').invoke('scrollTop').should('not.equal', 0);

     

       46
       46
       +
       });

     

       47
       47
       +
       

     

       48
       48
       +
       it('waits to restore scroll position until required scrollHeight is reached', () => {

     

       49
       49
       +
         const Main = () => {

     

       50
       50
       +
           const [showBlock, setShowBlock] = useState(false);

     

       51
       51
       +
           const ref = useRef<HTMLDivElement>(null);

     

       52
       52
       +
           useScrollRestoration(ref);

     

       53
       53
       +
       

     

       54
       54
       +
           return (

     

       55
       55
       +
             <div

     

       56
       56
       +
               id="container"

     

       57
       57
       +
               style={{ border: '1px solid red', overflowY: 'scroll', maxHeight: 100 }}

     

       58
       58
       +
               ref={ref}

     

       59
       59
       +
             >

     

       60
       60
       +
               <div style={{ height: 400 }}>block #1</div>

     

       61
       61
       +
               <button id="extend" onClick={() => setShowBlock(x => !x)}>Show Block</button>

     

       62
       62
       +
               {showBlock && <div style={{ height: 400 }}>block #2</div>}

     

       63
       63
       +
             </div>

     

       64
       64
       +
           );

     

       65
       65
       +
         };

     

       66
       66
       +
       

     

       67
       67
       +
         cy.window().then(window => {

     

       68
       68
       +
           window.history.pushState({}, '', '' + window.location);

     

       69
       69
       +
         });

     

       70
       70
       +
       

     

       71
       71
       +
         mount(<Main />);

     

       72
       72
       +
       

     

       73
       73
       +
         cy.get('#extend').realClick();

     

       74
       74
       +
         cy.get('#container').scrollTo('bottom');

     

       75
       75
       +
         cy.get('#container').trigger('scroll');

     

       76
       76
       +
       

     

       77
       77
       +
         cy.window().then(window => {

     

       78
       78
       +
           window.history.pushState({}, '', '' + window.location + '?test');

     

       79
       79
       +
         });

     

       80
       80
       +
       

     

       81
       81
       +
         cy.get('#container').invoke('scrollTop').should('not.equal', 0);

     

       82
       82
       +
         cy.get('#extend').click();

     

       83
       83
       +
         cy.get('#container').scrollTo('top');

     

       84
       84
       +
       

     

       85
       85
       +
         cy.window().then(window => {

     

       86
       86
       +
           window.history.back();

     

       87
       87
       +
         });

     

       88
       88
       +
       

     

       89
       89
       +
         cy.get('#container').invoke('scrollTop').should('equal', 0);

     

       90
       90
       +
         // once the height is reached it'll scroll back

     

       91
       91
       +
         cy.get('#extend').click();

     

       92
       92
       +
         cy.get('#container').invoke('scrollTop').should('not.equal', 0);

     

       93
       93
       +
       });

+2 -13

src/useScrollRestoration.ts

···

       2
       2
        
       import { observeScrollArea } from './utils/observeScrollArea';

     

       3
       3
        
       import { Ref } from './types';

     

       4
       4
        
       

     

       5
       5
       -
       const getIdForState = (() => {

     

       6
       6
       -
         const defaultState = {};

     

       7
       7
       -
         const stateToId = new WeakMap<{}, string>();

     

       8
       8
       -
       

     

       9
       9
       -
         let uniqueID = 1;

     

       10
       10
       -
       

     

       11
       11
       -
         return (state?: {} | null): string => {

     

       12
       12
       -
           if (!state) state = defaultState;

     

       13
       13
       -
           let id = stateToId.get(state);

     

       14
       14
       -
           if (!id) stateToId.set(state, (id = (uniqueID++).toString(36)));

     

       15
       15
       -
           return `${id}${document.location}`;

     

       16
       16
       -
         };

     

       17
       17
       -
       })();

     

       5
       5
       +
       const getIdForState = (state?: {} | null): string =>

     

       6
       6
       +
         `${state ? JSON.stringify(state) : ''}${document.location}`;

     

       18
       7
        
       

     

       19
       8
        
       const scrollPositions: Record<string, [number, number]> = {};

     

       20
       9