commit 674c0d1a6d2649e14217e55227b6d4cfd8798b1d · kitten.sh/use-interactions

+166

src/__tests__/useDialogFocus.test.tsx

···

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

     

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

     

       3
       3
       +
       

     

       4
       4
       +
       import { useDialogFocus } from '../useDialogFocus';

     

       5
       5
       +
       

     

       6
       6
       +
       it('allows dialogs to be navigated without an owner', () => {

     

       7
       7
       +
         const Dialog = () => {

     

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

     

       9
       9
       +
           useDialogFocus(ref);

     

       10
       10
       +
           return (

     

       11
       11
       +
             <ul ref={ref} role="dialog">

     

       12
       12
       +
               <li tabIndex={0}>#1</li>

     

       13
       13
       +
               <li tabIndex={0}>#2</li>

     

       14
       14
       +
               <li tabIndex={0}>#3</li>

     

       15
       15
       +
             </ul>

     

       16
       16
       +
           );

     

       17
       17
       +
         };

     

       18
       18
       +
       

     

       19
       19
       +
         const App = () => {

     

       20
       20
       +
           const [hasDialog, setDialog] = useState(false);

     

       21
       21
       +
           return (

     

       22
       22
       +
             <main>

     

       23
       23
       +
               <input type="text" name="text" onFocus={() => setDialog(true)} />

     

       24
       24
       +
               {hasDialog && <Dialog />}

     

       25
       25
       +
             </main>

     

       26
       26
       +
           );

     

       27
       27
       +
         };

     

       28
       28
       +
       

     

       29
       29
       +
         mount(<App />);

     

       30
       30
       +
       

     

       31
       31
       +
         cy.get('input').first().as('input').focus();

     

       32
       32
       +
         cy.focused().should('have.property.name', 'text');

     

       33
       33
       +
       

     

       34
       34
       +
         // ArrowRight/ArrowLeft shouldn't affect the selection for inputs

     

       35
       35
       +
         cy.realPress('ArrowRight');

     

       36
       36
       +
         cy.realPress('ArrowLeft');

     

       37
       37
       +
         cy.get('@input').should('have.focus');

     

       38
       38
       +
       

     

       39
       39
       +
         // Navigation with arrow keys is normal otherwise

     

       40
       40
       +
         cy.realPress('ArrowDown');

     

       41
       41
       +
         cy.realPress('ArrowDown');

     

       42
       42
       +
         cy.focused().contains('#2');

     

       43
       43
       +
         cy.realPress('ArrowRight');

     

       44
       44
       +
         cy.focused().contains('#3');

     

       45
       45
       +
         cy.realPress('ArrowLeft');

     

       46
       46
       +
         cy.focused().contains('#2');

     

       47
       47
       +
       

     

       48
       48
       +
         // permits special key navigation

     

       49
       49
       +
         cy.realPress('Home');

     

       50
       50
       +
         cy.focused().contains('#1');

     

       51
       51
       +
         cy.realPress('End');

     

       52
       52
       +
         cy.focused().contains('#3');

     

       53
       53
       +
       

     

       54
       54
       +
         // releases focus to original element on escape

     

       55
       55
       +
         cy.realPress('Escape');

     

       56
       56
       +
         cy.get('@input').should('have.focus');

     

       57
       57
       +
       });

     

       58
       58
       +
       

     

       59
       59
       +
       it('should not allow the dialog to be tabbable', () => {

     

       60
       60
       +
         const Dialog = () => {

     

       61
       61
       +
           const ref = useRef<HTMLUListElement>(null);

     

       62
       62
       +
           useDialogFocus(ref);

     

       63
       63
       +
           return (

     

       64
       64
       +
             <ul ref={ref} role="dialog">

     

       65
       65
       +
               <li tabIndex={0}>#1</li>

     

       66
       66
       +
               <li tabIndex={0}>#2</li>

     

       67
       67
       +
               <li tabIndex={0}>#3</li>

     

       68
       68
       +
             </ul>

     

       69
       69
       +
           );

     

       70
       70
       +
         };

     

       71
       71
       +
       

     

       72
       72
       +
         const App = () => {

     

       73
       73
       +
           const [hasDialog, setDialog] = useState(false);

     

       74
       74
       +
           return (

     

       75
       75
       +
             <main>

     

       76
       76
       +
               <button>before</button>

     

       77
       77
       +
               <input type="text" name="text" onFocus={() => setDialog(true)} />

     

       78
       78
       +
               {hasDialog && <Dialog />}

     

       79
       79
       +
               <button>after</button>

     

       80
       80
       +
             </main>

     

       81
       81
       +
           );

     

       82
       82
       +
         };

     

       83
       83
       +
       

     

       84
       84
       +
         mount(<App />);

     

       85
       85
       +
       

     

       86
       86
       +
         cy.get('input').first().as('input').focus();

     

       87
       87
       +
         cy.focused().should('have.property.name', 'text');

     

       88
       88
       +
       

     

       89
       89
       +
         // Tabbing should skip over the dialog

     

       90
       90
       +
         cy.realPress('Tab');

     

       91
       91
       +
         cy.focused().contains('after');

     

       92
       92
       +
         // Tabbing back should skip over the dialog

     

       93
       93
       +
         cy.realPress(['Shift', 'Tab']);

     

       94
       94
       +
         cy.get('@input').should('have.focus');

     

       95
       95
       +
         // Tabbing back on the owner shouldn't affect the dialog

     

       96
       96
       +
         cy.realPress(['Shift', 'Tab']);

     

       97
       97
       +
         cy.focused().contains('before');

     

       98
       98
       +
         // It should still know which element the owner was

     

       99
       99
       +
         cy.realPress('Tab');

     

       100
       100
       +
         cy.realPress('ArrowDown');

     

       101
       101
       +
         cy.focused().contains('#1');

     

       102
       102
       +
         // From inside the dialog tabbing should skip out of the dialog

     

       103
       103
       +
         cy.realPress('Tab');

     

       104
       104
       +
         cy.focused().contains('after');

     

       105
       105
       +
       });

     

       106
       106
       +
       

     

       107
       107
       +
       it('supports being attached to an owner element', () => {

     

       108
       108
       +
         const Dialog = () => {

     

       109
       109
       +
           const ownerRef = useRef<HTMLInputElement>(null);

     

       110
       110
       +
           const ref = useRef<HTMLUListElement>(null);

     

       111
       111
       +
       

     

       112
       112
       +
           useDialogFocus(ref, { ownerRef });

     

       113
       113
       +
       

     

       114
       114
       +
           return (

     

       115
       115
       +
             <main>

     

       116
       116
       +
               <input type="text" name="text" ref={ownerRef} />

     

       117
       117
       +
               <ul ref={ref} role="dialog">

     

       118
       118
       +
                 <li tabIndex={0}>#1</li>

     

       119
       119
       +
                 <li tabIndex={0}>#2</li>

     

       120
       120
       +
                 <li tabIndex={0}>#3</li>

     

       121
       121
       +
               </ul>

     

       122
       122
       +
             </main>

     

       123
       123
       +
           );

     

       124
       124
       +
         };

     

       125
       125
       +
       

     

       126
       126
       +
         mount(<Dialog />);

     

       127
       127
       +
       

     

       128
       128
       +
         cy.get('input').first().as('input').focus();

     

       129
       129
       +
         cy.focused().should('have.property.name', 'text');

     

       130
       130
       +
       

     

       131
       131
       +
         // pressing escape on input shouldn't change focus

     

       132
       132
       +
         cy.realPress('Escape');

     

       133
       133
       +
         cy.get('@input').should('have.focus');

     

       134
       134
       +
       

     

       135
       135
       +
         // pressing arrow down should start focusing the menu

     

       136
       136
       +
         cy.get('@input').focus();

     

       137
       137
       +
         cy.realPress('ArrowDown');

     

       138
       138
       +
         cy.focused().contains('#1');

     

       139
       139
       +
         cy.realPress('ArrowDown');

     

       140
       140
       +
         cy.focused().contains('#2');

     

       141
       141
       +
       

     

       142
       142
       +
         // tabbing should skip over the dialog items

     

       143
       143
       +
         cy.realPress(['Shift', 'Tab']);

     

       144
       144
       +
         cy.get('@input').should('have.focus');

     

       145
       145
       +
       

     

       146
       146
       +
         // pressing arrow up should start focusing the last item

     

       147
       147
       +
         cy.get('@input').focus();

     

       148
       148
       +
         cy.realPress('ArrowUp');

     

       149
       149
       +
         cy.focused().contains('#3');

     

       150
       150
       +
       

     

       151
       151
       +
         // pressing enter should start focusing the first item

     

       152
       152
       +
         cy.get('@input').focus();

     

       153
       153
       +
         cy.realPress('Enter');

     

       154
       154
       +
         cy.focused().contains('#1');

     

       155
       155
       +
       

     

       156
       156
       +
         // typing regular values should refocus the owner input

     

       157
       157
       +
         cy.realType('test');

     

       158
       158
       +
         cy.get('@input')

     

       159
       159
       +
           .should('have.focus')

     

       160
       160
       +
           .should('have.value', 'test');

     

       161
       161
       +
       

     

       162
       162
       +
         // pressing escape should refocus input

     

       163
       163
       +
         cy.get('li').first().focus();

     

       164
       164
       +
         cy.realPress('Escape');

     

       165
       165
       +
         cy.get('@input').should('have.focus');

     

       166
       166
       +
       });

-7

src/__tests__/useDialogFocus.tsx

···

       1
       1
       -
       import React, { useRef } from 'react';

     

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

     

       3
       3
       -
       

     

       4
       4
       -
       import { useDialogFocus } from '../useDialogFocus';

     

       5
       5
       -
       

     

       6
       6
       -
       it('allows dialogs to be navigated', () => {

     

       7
       7
       -
       });

+1 -1

src/__tests__/useMenuFocus.test.tsx

···

       125
       125
        
         cy.realPress('ArrowUp');

     

       126
       126
        
         cy.focused().contains('#3');

     

       127
       127
        
       

     

       128
       128
       -
         // pressing arrow up should start focusing the last item

     

       128
       128
       +
         // pressing enter should start focusing the first item

     

       129
       129
        
         cy.get('@input').focus();

     

       130
       130
        
         cy.realPress('Enter');

     

       131
       131
        
         cy.focused().contains('#1');

+2 -2

src/useDialogFocus.ts

···

       50
       50
        
       

     

       51
       51
        
             if (

     

       52
       52
        
               willReceiveFocus ||

     

       53
       53
       -
               (hasPriority && owner && event.target === owner)

     

       53
       53
       +
               (hasPriority && owner && contains(event.target, owner))

     

       54
       54
        
             ) {

     

       55
       55
        
               if (!contains(ref.current, active))

     

       56
       56
        
                 selection = snapshotSelection(owner);

     
···

       160
       160
        
               }

     

       161
       161
        
             } else if (

     

       162
       162
        
               owner &&

     

       163
       163
       -
               contains(owner, active) &&

     

       164
       163
        
               isInputElement(owner) &&

     

       164
       164
       +
               !contains(owner, active) &&

     

       165
       165
        
               /^(?:Key|Digit)/.test(event.code)

     

       166
       166
        
             ) {

     

       167
       167
        
               // Restore selection if a key is pressed on input

+1 -1

src/utils/focus.ts

···

       76
       76
        
           while (

     

       77
       77
        
             (next = reverse ? next.previousElementSibling : next.nextElementSibling)

     

       78
       78
        
           ) {

     

       79
       79
       -
             if (isVisible(next) && !!node.matches(focusableSelectors)) {

     

       79
       79
       +
             if (isVisible(next) && !!next.matches(focusableSelectors)) {

     

       80
       80
        
               return next as HTMLElement;

     

       81
       81
        
             } else if (hasFocusTargets(next)) {

     

       82
       82
        
               const targets = getFocusTargets(next);