From 06c018a522b10a03ab527987e5db40eff397cf37 Mon Sep 17 00:00:00 2001 From: web-padawan Date: Fri, 29 Nov 2019 13:40:18 +0200 Subject: [PATCH] feat: implement roving-tabindex-mixin --- packages/roving-tabindex-mixin/LICENSE | 190 ++++++++++++++++++ packages/roving-tabindex-mixin/README.md | 9 + packages/roving-tabindex-mixin/package.json | 30 +++ .../roving-tabindex-mixin.ts | 70 +++++++ .../test/roving-tabindex-mixin.test.ts | 161 +++++++++++++++ packages/roving-tabindex-mixin/tsconfig.json | 10 + 6 files changed, 470 insertions(+) create mode 100644 packages/roving-tabindex-mixin/LICENSE create mode 100644 packages/roving-tabindex-mixin/README.md create mode 100644 packages/roving-tabindex-mixin/package.json create mode 100644 packages/roving-tabindex-mixin/roving-tabindex-mixin.ts create mode 100644 packages/roving-tabindex-mixin/test/roving-tabindex-mixin.test.ts create mode 100644 packages/roving-tabindex-mixin/tsconfig.json diff --git a/packages/roving-tabindex-mixin/LICENSE b/packages/roving-tabindex-mixin/LICENSE new file mode 100644 index 0000000..faa9031 --- /dev/null +++ b/packages/roving-tabindex-mixin/LICENSE @@ -0,0 +1,190 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2019 Vaadin Ltd. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/roving-tabindex-mixin/README.md b/packages/roving-tabindex-mixin/README.md new file mode 100644 index 0000000..57b333a --- /dev/null +++ b/packages/roving-tabindex-mixin/README.md @@ -0,0 +1,9 @@ +# @vaadin/roving-tabindex-mixin + +This package provides `RovingTabIndexMixin` that does the following: + +1. When one of the items receives focus, set its `tabIndex` to 0 + +2. Set `tabIndex` to -1 for all the items except the focused one + +The mixin accepts a class that must apply `SlottedItemsMixin` and `KeyboardDirectionMixin`. diff --git a/packages/roving-tabindex-mixin/package.json b/packages/roving-tabindex-mixin/package.json new file mode 100644 index 0000000..7c561e6 --- /dev/null +++ b/packages/roving-tabindex-mixin/package.json @@ -0,0 +1,30 @@ +{ + "name": "@vaadin/roving-tabindex-mixin", + "version": "0.0.0", + "author": "Vaadin Ltd", + "license": "Apache-2.0", + "repository": { + "type": "git", + "url": "https://github.com/vaadin/component-mixins.git", + "directory": "packages/roving-tabindex-mixin" + }, + "main": "roving-tabindex-mixin.js", + "module": "roving-tabindex-mixin.js", + "files": [ + "roving-tabindex-mixin.d.ts*", + "roving-tabindex-mixin.js*" + ], + "dependencies": { + "@vaadin/keyboard-direction-mixin": "^0.0.0", + "@vaadin/slotted-items-mixin": "^0.0.0", + "lit-element": "^2.0.0", + "lit-html": "^1.0.0" + }, + "devDependencies": { + "@open-wc/testing-helpers": "^1.2.1", + "@vaadin/test-helpers": "^0.1.0" + }, + "publishConfig": { + "access": "public" + } +} diff --git a/packages/roving-tabindex-mixin/roving-tabindex-mixin.ts b/packages/roving-tabindex-mixin/roving-tabindex-mixin.ts new file mode 100644 index 0000000..1ff6c2a --- /dev/null +++ b/packages/roving-tabindex-mixin/roving-tabindex-mixin.ts @@ -0,0 +1,70 @@ +import { LitElement } from 'lit-element'; +import { + KeyboardDirectionClass, + KeyboardDirectionInterface, + getAvailableIndex, + isFocusable +} from '@vaadin/keyboard-direction-mixin'; +import { SlottedItemsClass, SlottedItemsInterface } from '@vaadin/slotted-items-mixin'; + +// eslint-disable-next-line @typescript-eslint/no-explicit-any +type Constructor = new (...args: any[]) => T; + +export abstract class RovingTabIndexClass extends LitElement { + protected _setFocusable?(idx: number): void; + + protected _setTabIndex?(item: HTMLElement): void; +} + +export const RovingTabIndexMixin = < + T extends Constructor< + KeyboardDirectionClass & + KeyboardDirectionInterface & + SlottedItemsClass & + SlottedItemsInterface & + LitElement + > +>( + base: T +): T & Constructor => { + class RovingTabIndex extends base { + focus() { + const first = + (this.querySelector('[tabindex="0"]') as HTMLElement) || + (this.items.length ? this.items[0] : null); + if (first) { + first.focus(); + } + } + + protected _itemsChanged(items: HTMLElement[], oldItems: HTMLElement[]) { + super._itemsChanged && super._itemsChanged(items, oldItems); // eslint-disable-line no-unused-expressions + + if (items) { + const { focused } = this; + this._setFocusable( + focused && this.contains(focused) ? items.indexOf(focused as HTMLElement) : 0 + ); + } + } + + protected _setFocusable(idx: number) { + const index = getAvailableIndex(this.items, idx, 1, isFocusable); + this._setTabIndex(this.items[index]); + } + + protected _setTabIndex(item: HTMLElement) { + this.items.forEach((el: HTMLElement) => { + // eslint-disable-next-line no-param-reassign + el.tabIndex = el === item ? 0 : -1; + }); + } + + protected _focus(item: HTMLElement) { + super._focus && super._focus(item); // eslint-disable-line no-unused-expressions + this._setTabIndex(item); + } + } + + return RovingTabIndex; +}; diff --git a/packages/roving-tabindex-mixin/test/roving-tabindex-mixin.test.ts b/packages/roving-tabindex-mixin/test/roving-tabindex-mixin.test.ts new file mode 100644 index 0000000..55af72b --- /dev/null +++ b/packages/roving-tabindex-mixin/test/roving-tabindex-mixin.test.ts @@ -0,0 +1,161 @@ +import { LitElement, html, customElement } from 'lit-element'; +import { fixture } from '@open-wc/testing-helpers'; +import { arrowDown, arrowLeft, arrowRight, arrowUp, end, home, tab } from '@vaadin/test-helpers'; +import { KeyboardDirectionMixin } from '@vaadin/keyboard-direction-mixin'; +import { SlottedItemsMixin } from '@vaadin/slotted-items-mixin'; +import { RovingTabIndexMixin } from '../roving-tabindex-mixin'; + +const { expect } = chai; +const { sinon } = window; + +@customElement('rtm-element') +class RtmElement extends RovingTabIndexMixin( + KeyboardDirectionMixin(SlottedItemsMixin(LitElement)) +) { + render() { + return html` + +
+ +
+ `; + } +} + +describe('RovingTabIndexMixin', () => { + let element: RtmElement; + let items: HTMLElement[]; + + const expectTabIndexZero = (idx: number) => { + element.items.forEach((item, i) => expect(item.tabIndex).to.be.equal(i === idx ? 0 : -1)); + }; + + beforeEach(async () => { + element = await fixture(html` + +
Foo
+
Bar
+
Bay
+
Baz
+ + `); + + element.focus(); + items = element.items; + }); + + it('should set tabIndex to -1 to all items, except the first one', () => { + expectTabIndexZero(0); + }); + + it('should not move tabIndex when "ctrl" is pressed on "arrow-down" key', () => { + arrowDown(element, 'ctrl'); + expectTabIndexZero(0); + }); + + it('should not move tabIndex when "meta" is pressed on "arrow-down" key', () => { + arrowDown(element, 'meta'); + expectTabIndexZero(0); + }); + + it('should move tabIndex to next item on "arrow-down" key', () => { + arrowDown(element); + expectTabIndexZero(1); + }); + + it('should move tabIndex to next item on "arrow-right" key', () => { + arrowRight(element); + expectTabIndexZero(1); + }); + + it('should move tabIndex to prev item on "arrow-up" key', () => { + arrowDown(element); + arrowUp(element); + expectTabIndexZero(0); + }); + + it('should move tabIndex to prev item on "arrow-left" key', () => { + arrowRight(element); + arrowLeft(element); + expectTabIndexZero(0); + }); + + it('should move tabIndex to last item on "end" keydown', () => { + end(element); + expectTabIndexZero(3); + }); + + it('should move tabIndex to the first item on "home" key', () => { + end(element); + home(element); + expectTabIndexZero(0); + }); + + it('should move tabIndex to the first enabled item on "home" key', () => { + end(element); + items[0].setAttribute('disabled', ''); + home(element); + expectTabIndexZero(1); + }); + + it('should move tabIndex to the closest enabled item on "end" key', () => { + element.items[3].setAttribute('disabled', ''); + end(element); + expectTabIndexZero(1); + }); + + it('should move tabIndex to the first item on "arrow-down" key on the last item', () => { + end(element); + arrowDown(element); + expectTabIndexZero(0); + }); + + it('should move tabIndex to the last item on "arrow-up" key on the first item', () => { + arrowUp(element); + expectTabIndexZero(3); + }); + + it('should ignore and skip items with "disabled" attribute when moving tabIndex', () => { + arrowDown(element); + arrowDown(element); + expectTabIndexZero(3); + }); + + it('should ignore and skip items with "hidden" attribute when moving tabIndex', () => { + element.items[1].setAttribute('hidden', ''); + arrowDown(element); + expectTabIndexZero(3); + }); + + it('should not throw when calling focus before element is attached', () => { + expect(() => { + document.createElement('rtm-element').focus(); + }).to.not.throw(Error); + }); + + it('should re-focus previously focused item when moving focus back', async () => { + arrowDown(element); + tab(element); + const spy = sinon.spy(element.items[1], 'focus'); + element.focus(); + await element.updateComplete; + expect(spy).to.be.calledOnce; + expectTabIndexZero(1); + }); + + it('should set tabIndex to -1 on the newly added item', async () => { + const item = document.createElement('div'); + element.appendChild(item); + await element.updateComplete; + expect(item.tabIndex).to.equal(-1); + }); +}); diff --git a/packages/roving-tabindex-mixin/tsconfig.json b/packages/roving-tabindex-mixin/tsconfig.json new file mode 100644 index 0000000..fe3f23b --- /dev/null +++ b/packages/roving-tabindex-mixin/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "../../tsconfig.json", + "outDir": ".", + "compilerOptions": { + "composite": true + }, + "include": [ + "roving-tabindex-mixin.ts" + ] +}