fix: invoke setFocused only on events triggered by focusElement (#6060)

vaadin · Jun 27, 2023 · 4574703 · 4574703
1 parent 9b6ea2a
commit 4574703
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 20 deletions.
diff --git a/packages/component-base/src/delegate-focus-mixin.js b/packages/component-base/src/delegate-focus-mixin.js
@@ -166,7 +166,7 @@ export const DelegateFocusMixin = dedupingMixin(
       }
 
       /**
-       * @param {Event} event
+       * @param {FocusEvent} event
        * @return {boolean}
        * @protected
        * @override
@@ -175,6 +175,16 @@ export const DelegateFocusMixin = dedupingMixin(
         return event.target === this.focusElement;
       }
 
+      /**
+       * @param {FocusEvent} event
+       * @return {boolean}
+       * @protected
+       * @override
+       */
+      _shouldRemoveFocus(event) {
+        return event.target === this.focusElement;
+      }
+
       /**
        * @param {boolean} disabled
        * @param {boolean} oldDisabled

diff --git a/packages/component-base/test/delegate-focus-mixin.test.js b/packages/component-base/test/delegate-focus-mixin.test.js
@@ -1,37 +1,50 @@
 import { expect } from '@esm-bundle/chai';
-import { fixtureSync, nextFrame } from '@vaadin/testing-helpers';
+import { fixtureSync, focusin, focusout, nextFrame } from '@vaadin/testing-helpers';
 import sinon from 'sinon';
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
 import { DelegateFocusMixin } from '../src/delegate-focus-mixin.js';
 
-customElements.define(
-  'delegate-focus-mixin-element',
-  class extends DelegateFocusMixin(PolymerElement) {
-    static get template() {
-      return html`<slot name="input"></slot>`;
-    }
-
-    /** @protected */
-    ready() {
-      super.ready();
-
-      const input = this.querySelector('input');
-      this._setFocusElement(input);
-    }
-  },
-);
-
 describe('delegate-focus-mixin', () => {
-  let element, input;
+  let element, input, setFocusedSpy;
+
+  customElements.define(
+    'delegate-focus-mixin-element',
+    class extends DelegateFocusMixin(PolymerElement) {
+      static get template() {
+        return html`
+          <slot name="input"></slot>
+          <slot name="suffix"></slot>
+        `;
+      }
+
+      /** @protected */
+      ready() {
+        super.ready();
+
+        const input = this.querySelector('input');
+        this._setFocusElement(input);
+      }
+
+      _setFocused(focused) {
+        super._setFocused(focused);
+        setFocusedSpy?.(focused);
+      }
+    },
+  );
 
   describe('default', () => {
+    let button;
+
     beforeEach(() => {
+      setFocusedSpy = sinon.spy();
       element = fixtureSync(`
         <delegate-focus-mixin-element>
           <input slot="input" />
+          <button slot="suffix"></button>
         </delegate-focus-mixin-element>
       `);
       input = element.querySelector('input');
+      button = element.querySelector('button');
     });
 
     it('should focus the input on focus call', () => {
@@ -113,6 +126,16 @@ describe('delegate-focus-mixin', () => {
       element._setFocusElement(target);
       expect(target.disabled).to.be.false;
     });
+
+    it('should not invoke setFocused when focusin is not triggered by focusElement', () => {
+      focusin(button);
+      expect(setFocusedSpy.called).to.be.false;
+    });
+
+    it('should not invoke setFocused when focusout is not triggered by focusElement', () => {
+      focusout(button);
+      expect(setFocusedSpy.called).to.be.false;
+    });
   });
 
   describe('events', () => {