Fix focus not always returning to expected element on active=false

This is a new fix for the issue identified in #54 after gaining a better understanding of the issue. The `returnFocusOnDeactivate` flag was being special-cased, but not always, and the element to which focus should be returned, which focus-trap-react attempts to manage on its own (see class Constructor comment for reasoning), was not always correct. For example, if the trap was deactivated, and then re-activated, the 'last focused element before activation' wasn't updated at the moment of re-activation, where it could've changed.
focus-trap · Oct 10, 2020 · 7150846 · 7150846
1 parent 749ecf5
commit 7150846
Show file tree

Hide file tree

Showing 4 changed files with 343 additions and 170 deletions.
diff --git a/.changeset/strong-emus-do.md b/.changeset/strong-emus-do.md
@@ -0,0 +1,5 @@
+---
+'focus-trap-react': patch
+---
+
+Fix focus not always returning to correct node after setting `active` prop to `false`.
diff --git a/cypress/integration/focus-trap-demo.spec.js b/cypress/integration/focus-trap-demo.spec.js
@@ -13,145 +13,232 @@ describe('<FocusTrap> component', () => {
     cy.get(focusedElAlias).should('be.focused');
   }
 
-  it('By default focus first element in its tab order and trap focus within its children', () => {
-    cy.get('#demo-defaults').as('testRoot');
-
-    // activate trap
-    cy.get('@testRoot')
-      .findByRole('button', { name: 'activate trap' })
-      .as('lastlyFocusedElementBeforeTrapIsActivated')
-      .click();
-
-    // 1st element should be focused
-    cy.get('@testRoot')
-      .findByRole('link', { name: 'with' })
-      .as('firstElementInTrap')
-      .should('be.focused');
-
-    // crucial focus-trap feature: mouse click is trapped
-    verifyCrucialFocusTrapOnClicking('@firstElementInTrap');
-
-    // trap is active(keep focus in trap by tabbing through the focus trap's tabbable elements)
-    cy.get('@firstElementInTrap')
-      .tab()
-      .should('have.text', 'some')
-      .should('be.focused')
-      .tab()
-      .should('have.text', 'focusable')
-      .should('be.focused')
-      .tab()
-      .as('lastElementInTrap')
-      .should('have.text', 'deactivate trap')
-      .should('be.focused')
-      .tab();
-
-    // trap is active(keep focus in trap by shift-tabbing through the focus trap's tabbable elements)
-    cy.get('@firstElementInTrap').should('be.focused').tab({ shift: true });
-    cy.get('@lastElementInTrap').should('be.focused');
-
-    // trap can be deactivated and return focus to lastly focused element before trap is activated
-    cy.get('@testRoot')
-      .findByRole('button', { name: 'deactivate trap' })
-      .click();
-    cy.get('@lastlyFocusedElementBeforeTrapIsActivated').should('have.focus');
-
-    // focus can be transitioned freely when trap is unmounted
-    let previousFocusedEl;
-    cy.get('@lastlyFocusedElementBeforeTrapIsActivated')
-      .then(([lastlyFocusedEl]) => (previousFocusedEl = lastlyFocusedEl))
-      .tab();
-    cy.focused().should(([nextFocusedEl]) =>
-      expect(nextFocusedEl).not.equal(previousFocusedEl)
-    );
-  });
-
-  it('On trap mounts and activates, focus on manually specified input element', () => {
-    cy.get('#demo-ffne').as('testRoot');
-
-    // activate trap
-    cy.get('@testRoot').findByRole('button', { name: 'activate trap' }).click();
-
-    // instead of next tab-order element being focused, element specified should be focused
-    cy.get('@testRoot')
-      .findByRole('textbox', { name: 'Initially focused input' })
-      .as('focusedEl')
-      .should('be.focused');
-
-    // crucial focus-trap feature: mouse click is trapped
-    verifyCrucialFocusTrapOnClicking('@focusedEl');
-  });
-
-  it('Escape key does not deactivate trap. Instead, click on "deactivate trap" to deactivate trap', () => {
-    cy.get('#demo-ffne').as('testRoot');
-
-    // activate trap
-    cy.get('@testRoot')
-      .findByRole('button', { name: 'activate trap' })
-      .as('lastlyFocusedElementBeforeTrapIsActivated')
-      .click();
-
-    // trying deactivate trap by ESC
-    cy.get('@testRoot')
-      .findByRole('textbox', { name: 'Initially focused input' })
-      .as('trapChild')
-      .focus()
-      .type('{esc}');
-
-    // ESC does not deactivate the trap
-    cy.get('@trapChild').should('exist').should('be.focused');
-
-    // crucial focus-trap feature: mouse click is trapped
-    verifyCrucialFocusTrapOnClicking('@trapChild');
-
-    // click on deactivate trap button to deactivate trap
-    cy.get('@testRoot')
-      .findByRole('button', { name: 'deactivate trap' })
-      .click();
-    cy.get('@trapChild').should('not.exist');
-    cy.get('@lastlyFocusedElementBeforeTrapIsActivated').should('be.focused');
+  describe('demo: defaults', () => {
+    it('By default focus first element in its tab order and trap focus within its children', () => {
+      cy.get('#demo-defaults').as('testRoot');
+
+      // activate trap
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'activate trap' })
+        .as('lastlyFocusedElementBeforeTrapIsActivated')
+        .click();
+
+      // 1st element should be focused
+      cy.get('@testRoot')
+        .findByRole('link', { name: 'with' })
+        .as('firstElementInTrap')
+        .should('be.focused');
+
+      // crucial focus-trap feature: mouse click is trapped
+      verifyCrucialFocusTrapOnClicking('@firstElementInTrap');
+
+      // trap is active(keep focus in trap by tabbing through the focus trap's tabbable elements)
+      cy.get('@firstElementInTrap')
+        .tab()
+        .should('have.text', 'some')
+        .should('be.focused')
+        .tab()
+        .should('have.text', 'focusable')
+        .should('be.focused')
+        .tab()
+        .as('lastElementInTrap')
+        .should('have.text', 'deactivate trap')
+        .should('be.focused')
+        .tab();
+
+      // trap is active(keep focus in trap by shift-tabbing through the focus trap's tabbable elements)
+      cy.get('@firstElementInTrap').should('be.focused').tab({ shift: true });
+      cy.get('@lastElementInTrap').should('be.focused');
+
+      // trap can be deactivated and return focus to lastly focused element before trap is activated
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'deactivate trap' })
+        .click();
+      cy.get('@lastlyFocusedElementBeforeTrapIsActivated').should('have.focus');
+
+      // focus can be transitioned freely when trap is unmounted
+      let previousFocusedEl;
+      cy.get('@lastlyFocusedElementBeforeTrapIsActivated')
+        .then(([lastlyFocusedEl]) => (previousFocusedEl = lastlyFocusedEl))
+        .tab();
+      cy.focused().should(([nextFocusedEl]) =>
+        expect(nextFocusedEl).not.equal(previousFocusedEl)
+      );
+    });
   });
 
-  it('Can be deactivated while staying mounted  ', () => {
-    cy.get('#demo-special-element').as('testRoot');
-
-    // activate trap
-    cy.get('@testRoot')
-      .findByRole('button', { name: 'activate trap' })
-      .as('lastlyFocusedElementBeforeTrapIsActivated')
-      .click();
-
-    // stay mounted after deactivation
-    cy.get('@testRoot')
-      .findByRole('button', { name: 'deactivate trap' })
-      .as('trapChild')
-      .click();
-    cy.get('@lastlyFocusedElementBeforeTrapIsActivated').should('be.focused');
-    cy.get('@trapChild').should('exist');
+  describe('demo: ffne', () => {
+    it('On trap mounts and activates, focus on manually specified input element', () => {
+      cy.get('#demo-ffne').as('testRoot');
+
+      // activate trap
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'activate trap' })
+        .click();
+
+      // instead of next tab-order element being focused, element specified should be focused
+      cy.get('@testRoot')
+        .findByRole('textbox', { name: 'Initially focused input' })
+        .as('focusedEl')
+        .should('be.focused');
+
+      // crucial focus-trap feature: mouse click is trapped
+      verifyCrucialFocusTrapOnClicking('@focusedEl');
+    });
+
+    it('Escape key does not deactivate trap. Instead, click on "deactivate trap" to deactivate trap', () => {
+      cy.get('#demo-ffne').as('testRoot');
+
+      // activate trap
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'activate trap' })
+        .as('lastlyFocusedElementBeforeTrapIsActivated')
+        .click();
+
+      // trying deactivate trap by ESC
+      cy.get('@testRoot')
+        .findByRole('textbox', { name: 'Initially focused input' })
+        .as('trapChild')
+        .focus()
+        .type('{esc}');
+
+      // ESC does not deactivate the trap
+      cy.get('@trapChild').should('exist').should('be.focused');
+
+      // crucial focus-trap feature: mouse click is trapped
+      verifyCrucialFocusTrapOnClicking('@trapChild');
+
+      // click on deactivate trap button to deactivate trap
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'deactivate trap' })
+        .click();
+      cy.get('@trapChild').should('not.exist');
+      cy.get('@lastlyFocusedElementBeforeTrapIsActivated').should('be.focused');
+    });
   });
 
-  it('Can click outside of trap to deactivate and click carries through  ', () => {
-    cy.get('#demo-special-element').as('testRoot');
-
-    // activate trap
-    cy.get('@testRoot').findByRole('button', { name: 'activate trap' }).click();
-
-    // click outside to deactivate trap and also click carries through
-    cy.findByRole('button', { name: 'pass thru click' })
-      .click()
-      .should('be.focused');
-    cy.get('@testRoot').findByText('Clicked!');
+  describe('demo: special element', () => {
+    // because this test allows click-through to deactivate, we can't use
+    //  verifyCrucialFocusTrapOnClicking() because it clicks outside, and will
+    //  cause the trap to be deactivated
+    const verifyFocusTrapped = function () {
+      // 1st element should be focused
+      cy.get('@testRoot')
+        .findByRole('link', { name: 'with' })
+        .as('firstElementInTrap')
+        .should('be.focused');
+
+      // trap is active(keep focus in trap by tabbing through the focus trap's tabbable elements)
+      cy.get('@firstElementInTrap')
+        .tab()
+        .should('have.text', 'some')
+        .should('be.focused')
+        .tab()
+        .should('have.text', 'focusable')
+        .should('be.focused')
+        .tab()
+        .as('lastElementInTrap')
+        .should('have.text', 'deactivate trap')
+        .should('be.focused')
+        .tab();
+
+      // trap is active(keep focus in trap by shift-tabbing through the focus trap's tabbable elements)
+      cy.get('@firstElementInTrap').should('be.focused').tab({ shift: true });
+      cy.get('@lastElementInTrap').should('be.focused');
+    };
+
+    it('Can be deactivated while staying mounted by clicking on deactivate', () => {
+      cy.get('#demo-special-element').as('testRoot');
+
+      // activate trap
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'activate trap' })
+        .as('lastlyFocusedElementBeforeTrapIsActivated')
+        .click();
+
+      verifyFocusTrapped();
+
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'deactivate trap' })
+        .as('trapChild')
+        .click();
+
+      cy.get('@lastlyFocusedElementBeforeTrapIsActivated').should('be.focused');
+
+      // stay mounted after deactivation
+      cy.get('@trapChild').should('exist');
+    });
+
+    it('Can be deactivated while staying mounted by pressing ESC key', () => {
+      cy.get('#demo-special-element').as('testRoot');
+
+      // activate trap
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'activate trap' })
+        .as('lastlyFocusedElementBeforeTrapIsActivated')
+        .click();
+
+      verifyFocusTrapped();
+
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'deactivate trap' })
+        .as('trapChild')
+        .type('{esc}');
+
+      cy.get('@lastlyFocusedElementBeforeTrapIsActivated').should('be.focused');
+
+      // stay mounted after deactivation
+      cy.get('@trapChild').should('exist');
+    });
+
+    it('Can click outside of trap to deactivate and click carries through', () => {
+      cy.get('#demo-special-element').as('testRoot');
+
+      // activate trap
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'activate trap' })
+        .as('lastlyFocusedElementBeforeTrapIsActivated')
+        .click();
+
+      verifyFocusTrapped();
+
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'deactivate trap' })
+        .as('trapChild');
+
+      // click outside to deactivate trap and also click carries through
+      cy.findByRole('button', { name: 'pass thru click' })
+        .as('passThru')
+        .click();
+
+      // activate button should NOT be focused because click should've gone through to passThru button
+      cy.get('@lastlyFocusedElementBeforeTrapIsActivated').should(
+        'not.be.focused'
+      );
+
+      // stay mounted after deactivation
+      cy.get('@trapChild').should('exist');
+
+      // passThru button has focus and click event was processed
+      cy.get('@passThru').should('be.focused');
+      cy.get('@testRoot').findByText('Clicked!');
+    });
   });
 
-  it('Focus on element with "autofocus" attribute than the 1st tab order element within mounted trap children', () => {
-    cy.get('#demo-autofocus').as('testRoot');
+  describe('demo: autofocus', () => {
+    it('Focus on element with "autofocus" attribute than the 1st tab order element within mounted trap children', () => {
+      cy.get('#demo-autofocus').as('testRoot');
 
-    // activate trap
-    cy.get('@testRoot').findByRole('button', { name: 'activate trap' }).click();
+      // activate trap
+      cy.get('@testRoot')
+        .findByRole('button', { name: 'activate trap' })
+        .click();
 
-    // element with "autofocus" attribute is focused
-    cy.findByTestId('autofocus-el').as('trapChild').should('be.focused');
+      // element with "autofocus" attribute is focused
+      cy.findByTestId('autofocus-el').as('trapChild').should('be.focused');
 
-    // crucial focus-trap feature: mouse click is trapped
-    verifyCrucialFocusTrapOnClicking('@trapChild');
+      // crucial focus-trap feature: mouse click is trapped
+      verifyCrucialFocusTrapOnClicking('@trapChild');
+    });
   });
 });