|
| 1 | +import { describe, expect, it, vi } from "vite-plus/test"; |
| 2 | + |
| 3 | +import { createSoftwareKeyboardStore } from "./softwareKeyboard"; |
| 4 | + |
| 5 | +function fixture(options: { native?: boolean; overlay?: boolean; desktop?: boolean } = {}) { |
| 6 | + const viewport = Object.assign(new EventTarget(), { width: 390, height: 844, scale: 1 }); |
| 7 | + const keyboard = Object.assign(new EventTarget(), { |
| 8 | + boundingRect: { height: 0 }, |
| 9 | + overlaysContent: options.overlay ?? false, |
| 10 | + }); |
| 11 | + const win = { |
| 12 | + innerHeight: 844, |
| 13 | + visualViewport: viewport, |
| 14 | + navigator: options.native ? { virtualKeyboard: keyboard } : {}, |
| 15 | + }; |
| 16 | + const store = createSoftwareKeyboardStore(win as unknown as Window, options.desktop ?? false); |
| 17 | + const resize = (height: number, width = viewport.width, scale = viewport.scale) => { |
| 18 | + Object.assign(viewport, { height, width, scale }); |
| 19 | + viewport.dispatchEvent(new Event("resize")); |
| 20 | + }; |
| 21 | + const geometry = (height: number) => { |
| 22 | + keyboard.boundingRect.height = height; |
| 23 | + keyboard.dispatchEvent(new Event("geometrychange")); |
| 24 | + }; |
| 25 | + return { store, viewport, keyboard, win, resize, geometry }; |
| 26 | +} |
| 27 | + |
| 28 | +describe("software keyboard detection", () => { |
| 29 | + it("follows native keyboard geometry even when the viewport does not resize", () => { |
| 30 | + const { store, geometry } = fixture({ native: true, overlay: true }); |
| 31 | + const observed: boolean[] = []; |
| 32 | + const unsubscribe = store.subscribe(() => observed.push(store.getSnapshot())); |
| 33 | + expect(store.getSnapshot()).toBe(false); |
| 34 | + |
| 35 | + geometry(300); |
| 36 | + expect(store.getSnapshot()).toBe(true); |
| 37 | + geometry(0); |
| 38 | + expect(store.getSnapshot()).toBe(false); |
| 39 | + expect(observed).toEqual([true, false]); |
| 40 | + |
| 41 | + unsubscribe(); |
| 42 | + geometry(300); |
| 43 | + expect(observed).toEqual([true, false]); |
| 44 | + }); |
| 45 | + |
| 46 | + it("reads keyboard geometry that was already present before subscribing", () => { |
| 47 | + const { store, keyboard } = fixture({ native: true }); |
| 48 | + keyboard.boundingRect.height = 300; |
| 49 | + expect(store.getSnapshot()).toBe(true); |
| 50 | + }); |
| 51 | + |
| 52 | + it("prefers overlay geometry over a misleading viewport height", () => { |
| 53 | + const { store, resize, geometry } = fixture({ native: true, overlay: true }); |
| 54 | + const unsubscribe = store.subscribe(() => {}); |
| 55 | + resize(500); |
| 56 | + expect(store.getSnapshot()).toBe(false); |
| 57 | + geometry(300); |
| 58 | + expect(store.getSnapshot()).toBe(true); |
| 59 | + geometry(0); |
| 60 | + expect(store.getSnapshot()).toBe(false); |
| 61 | + unsubscribe(); |
| 62 | + }); |
| 63 | + |
| 64 | + it.each([false, true])("falls back to viewport changes with native API present: %s", (native) => { |
| 65 | + const { store, resize, keyboard } = fixture({ native }); |
| 66 | + const unsubscribe = store.subscribe(() => {}); |
| 67 | + |
| 68 | + resize(500); |
| 69 | + expect(store.getSnapshot()).toBe(true); |
| 70 | + resize(550); |
| 71 | + expect(store.getSnapshot()).toBe(true); |
| 72 | + resize(844); |
| 73 | + expect(store.getSnapshot()).toBe(false); |
| 74 | + expect(keyboard.overlaysContent).toBe(false); |
| 75 | + unsubscribe(); |
| 76 | + }); |
| 77 | + |
| 78 | + it("detects a docked keyboard when subscribing after it has opened", () => { |
| 79 | + const { store, resize } = fixture(); |
| 80 | + resize(500); |
| 81 | + const unsubscribe = store.subscribe(() => {}); |
| 82 | + expect(store.getSnapshot()).toBe(true); |
| 83 | + resize(844); |
| 84 | + expect(store.getSnapshot()).toBe(false); |
| 85 | + unsubscribe(); |
| 86 | + }); |
| 87 | + |
| 88 | + it("ignores small height changes such as the browser toolbar", () => { |
| 89 | + const { store, resize } = fixture(); |
| 90 | + const unsubscribe = store.subscribe(() => {}); |
| 91 | + resize(750); |
| 92 | + expect(store.getSnapshot()).toBe(false); |
| 93 | + resize(700); |
| 94 | + expect(store.getSnapshot()).toBe(false); |
| 95 | + unsubscribe(); |
| 96 | + }); |
| 97 | + |
| 98 | + it("ignores window resizing even with a large height change", () => { |
| 99 | + const { store, resize, win } = fixture(); |
| 100 | + const unsubscribe = store.subscribe(() => {}); |
| 101 | + win.innerHeight = 500; |
| 102 | + resize(500); |
| 103 | + expect(store.getSnapshot()).toBe(false); |
| 104 | + unsubscribe(); |
| 105 | + }); |
| 106 | + |
| 107 | + it("ignores pinch zoom and recognizes keyboard changes at the new scale", () => { |
| 108 | + const { store, resize } = fixture(); |
| 109 | + const unsubscribe = store.subscribe(() => {}); |
| 110 | + resize(422, 195, 2); |
| 111 | + expect(store.getSnapshot()).toBe(false); |
| 112 | + resize(300); |
| 113 | + expect(store.getSnapshot()).toBe(true); |
| 114 | + resize(422); |
| 115 | + expect(store.getSnapshot()).toBe(false); |
| 116 | + unsubscribe(); |
| 117 | + }); |
| 118 | + |
| 119 | + it("does not mistake an already zoomed viewport for an open keyboard", () => { |
| 120 | + const { store, resize } = fixture(); |
| 121 | + resize(422, 195, 2); |
| 122 | + const unsubscribe = store.subscribe(() => {}); |
| 123 | + expect(store.getSnapshot()).toBe(false); |
| 124 | + unsubscribe(); |
| 125 | + }); |
| 126 | + |
| 127 | + it("does not mistake rotation for an open keyboard", () => { |
| 128 | + const { store, resize, win } = fixture(); |
| 129 | + const unsubscribe = store.subscribe(() => {}); |
| 130 | + win.innerHeight = 390; |
| 131 | + resize(390, 844); |
| 132 | + expect(store.getSnapshot()).toBe(false); |
| 133 | + unsubscribe(); |
| 134 | + }); |
| 135 | + |
| 136 | + it("shares listeners and refreshes state after the final subscriber leaves", () => { |
| 137 | + const { store, resize } = fixture(); |
| 138 | + const first = vi.fn(); |
| 139 | + const second = vi.fn(); |
| 140 | + const unsubscribeFirst = store.subscribe(first); |
| 141 | + const unsubscribeSecond = store.subscribe(second); |
| 142 | + resize(500); |
| 143 | + expect(store.getSnapshot()).toBe(true); |
| 144 | + expect(first).toHaveBeenCalledOnce(); |
| 145 | + expect(second).toHaveBeenCalledOnce(); |
| 146 | + unsubscribeFirst(); |
| 147 | + resize(550); |
| 148 | + expect(first).toHaveBeenCalledOnce(); |
| 149 | + expect(second).toHaveBeenCalledTimes(2); |
| 150 | + unsubscribeSecond(); |
| 151 | + resize(844); |
| 152 | + expect(second).toHaveBeenCalledTimes(2); |
| 153 | + |
| 154 | + const unsubscribe = store.subscribe(first); |
| 155 | + expect(store.getSnapshot()).toBe(false); |
| 156 | + unsubscribe(); |
| 157 | + }); |
| 158 | + |
| 159 | + it("recognizes keyboard closure despite viewport rounding at high zoom", () => { |
| 160 | + const { store, resize } = fixture(); |
| 161 | + resize(211, 98, 4); |
| 162 | + const unsubscribe = store.subscribe(() => {}); |
| 163 | + resize(150); |
| 164 | + expect(store.getSnapshot()).toBe(true); |
| 165 | + resize(210.6); |
| 166 | + expect(store.getSnapshot()).toBe(false); |
| 167 | + unsubscribe(); |
| 168 | + }); |
| 169 | + |
| 170 | + it("bypasses both native geometry and viewport detection on desktop", () => { |
| 171 | + const { store, geometry, resize } = fixture({ native: true, overlay: true, desktop: true }); |
| 172 | + const listener = vi.fn(); |
| 173 | + const unsubscribe = store.subscribe(listener); |
| 174 | + geometry(300); |
| 175 | + resize(500); |
| 176 | + expect(store.getSnapshot()).toBe(false); |
| 177 | + expect(listener).not.toHaveBeenCalled(); |
| 178 | + unsubscribe(); |
| 179 | + }); |
| 180 | + |
| 181 | + it("does not require browser APIs during server rendering", () => { |
| 182 | + const store = createSoftwareKeyboardStore(undefined, false); |
| 183 | + const unsubscribe = store.subscribe(() => {}); |
| 184 | + expect(store.getSnapshot()).toBe(false); |
| 185 | + unsubscribe(); |
| 186 | + }); |
| 187 | +}); |
0 commit comments