@@ -15,10 +15,6 @@ const entries = ["first", "second"].map((id) => ({
1515 droppedImageNames : [ ] ,
1616} ) ) ;
1717
18- const scrollIntoViewDescriptor = Object . getOwnPropertyDescriptor (
19- Element . prototype ,
20- "scrollIntoView" ,
21- ) ;
2218const getAnimationsDescriptor = Object . getOwnPropertyDescriptor ( Element . prototype , "getAnimations" ) ;
2319let root : Root ;
2420let host : HTMLDivElement ;
@@ -32,10 +28,6 @@ beforeEach(() => {
3228 disconnect ( ) { }
3329 } ,
3430 ) ;
35- Object . defineProperty ( Element . prototype , "scrollIntoView" , {
36- configurable : true ,
37- value : ( ) => { } ,
38- } ) ;
3931 Object . defineProperty ( Element . prototype , "getAnimations" , {
4032 configurable : true ,
4133 value : ( ) => [ ] ,
@@ -47,11 +39,6 @@ beforeEach(() => {
4739afterEach ( async ( ) => {
4840 await act ( ( ) => root . unmount ( ) ) ;
4941 host . remove ( ) ;
50- if ( scrollIntoViewDescriptor ) {
51- Object . defineProperty ( Element . prototype , "scrollIntoView" , scrollIntoViewDescriptor ) ;
52- } else {
53- Reflect . deleteProperty ( Element . prototype , "scrollIntoView" ) ;
54- }
5542 if ( getAnimationsDescriptor ) {
5643 Object . defineProperty ( Element . prototype , "getAnimations" , getAnimationsDescriptor ) ;
5744 } else {
@@ -61,111 +48,35 @@ afterEach(async () => {
6148 vi . unstubAllGlobals ( ) ;
6249} ) ;
6350
64- describe ( "stash keyboard scope" , ( ) => {
65- it . each ( [
66- { key : "Enter" } ,
67- { key : "Backspace" , ctrlKey : true } ,
68- { key : "Backspace" , metaKey : true } ,
69- ] ) ( "lets $key reach a dialog input while the drawer is open" , async ( key ) => {
70- const composerFormRef = createRef < HTMLFormElement > ( ) ;
71- const onRestore = vi . fn ( ) ;
72- const onDelete = vi . fn ( ) ;
73- const onClose = vi . fn ( ) ;
74- const onKeyDown = vi . fn ( ) ;
75- await act ( ( ) =>
76- root . render (
77- < >
78- < form ref = { composerFormRef } >
79- < div data-testid = "composer-editor" contentEditable />
80- </ form >
81- < ComposerStashMenu
82- composerFormRef = { composerFormRef }
83- entries = { entries }
84- stashShortcutLabel = "Ctrl+S"
85- onRestore = { onRestore }
86- onDelete = { onDelete }
87- onClose = { onClose }
88- />
89- < Dialog open >
90- < DialogPopup aria-label = "Command palette" >
91- < input aria-label = "Search commands" onKeyDown = { onKeyDown } />
92- </ DialogPopup >
93- </ Dialog >
94- </ > ,
95- ) ,
96- ) ;
97- const input = document . querySelector < HTMLInputElement > ( 'input[aria-label="Search commands"]' ) ! ;
98- await act ( ( ) => input . focus ( ) ) ;
99- const event = new KeyboardEvent ( "keydown" , { ...key , bubbles : true , cancelable : true } ) ;
100- await act ( ( ) => {
101- input . dispatchEvent ( event ) ;
102- } ) ;
103- expect ( onRestore ) . not . toHaveBeenCalled ( ) ;
104- expect ( onDelete ) . not . toHaveBeenCalled ( ) ;
105- expect ( onClose ) . not . toHaveBeenCalled ( ) ;
106- expect ( onKeyDown ) . toHaveBeenCalledOnce ( ) ;
107- expect ( event . defaultPrevented ) . toBe ( false ) ;
108- } ) ;
109- } ) ;
110-
111- async function renderComposer (
112- initialFocus ?: "editor" | "badge" | "other" ,
113- editorDisabled = false ,
114- removeDeletedEntries = false ,
115- ) {
51+ async function renderWithDialog ( ) {
11652 const composerFormRef = createRef < HTMLFormElement > ( ) ;
117- let currentEntries = entries ;
11853 const onRestore = vi . fn ( ) ;
119- const onDelete = vi . fn ( ( entry : { id : string } ) => {
120- if ( removeDeletedEntries ) {
121- currentEntries = currentEntries . filter ( ( candidate ) => candidate . id !== entry . id ) ;
122- root . render ( render ( currentEntries . length > 0 ) ) ;
123- }
124- } ) ;
125- const onClose = vi . fn ( ( ) => root . render ( render ( false ) ) ) ;
126- const render = ( showDrawer : boolean ) => (
127- < >
128- < form ref = { composerFormRef } >
129- < div
130- data-testid = "composer-editor"
131- // jsdom treats contenteditable="false" as focusable; omit it for the disabled fixture.
132- contentEditable = { editorDisabled ? undefined : true }
133- suppressContentEditableWarning
134- >
135- Draft
136- </ div >
137- < input aria-label = "Other composer field" />
138- < button type = "button" data-prompt-stash-badge = "true" >
139- Stash
140- </ button >
141- </ form >
142- < form >
143- < div data-testid = "composer-editor" contentEditable />
144- </ form >
145- { showDrawer && (
54+ const onDelete = vi . fn ( ) ;
55+ const onClose = vi . fn ( ) ;
56+ const onDialogKeyDown = vi . fn ( ) ;
57+ await act ( ( ) =>
58+ root . render (
59+ < >
60+ < form ref = { composerFormRef } >
61+ < div data-testid = "composer-editor" contentEditable suppressContentEditableWarning />
62+ </ form >
14663 < ComposerStashMenu
14764 composerFormRef = { composerFormRef }
148- entries = { currentEntries }
65+ entries = { entries }
14966 stashShortcutLabel = "Ctrl+S"
15067 onRestore = { onRestore }
15168 onDelete = { onDelete }
15269 onClose = { onClose }
15370 />
154- ) }
155- </ >
71+ < Dialog open >
72+ < DialogPopup aria-label = "Command palette" >
73+ < input aria-label = "Search commands" onKeyDown = { onDialogKeyDown } />
74+ </ DialogPopup >
75+ </ Dialog >
76+ </ > ,
77+ ) ,
15678 ) ;
157- if ( initialFocus ) {
158- await act ( ( ) => root . render ( render ( false ) ) ) ;
159- const selector =
160- initialFocus === "editor"
161- ? '[data-testid="composer-editor"]'
162- : initialFocus === "badge"
163- ? '[data-prompt-stash-badge="true"]'
164- : 'input[aria-label="Other composer field"]' ;
165- await act ( ( ) => host . querySelector < HTMLElement > ( selector ) ! . focus ( ) ) ;
166- }
167- await act ( ( ) => root . render ( render ( true ) ) ) ;
168- return { onRestore, onDelete, onClose } ;
79+ return { onRestore, onDelete, onClose, onDialogKeyDown } ;
16980}
17081
17182async function press ( target : HTMLElement , key : KeyboardEventInit ) {
@@ -176,169 +87,29 @@ async function press(target: HTMLElement, key: KeyboardEventInit) {
17687 return event ;
17788}
17889
179- it . each ( [ undefined , "badge" ] as const ) (
180- "focuses the composer editor when the drawer opens from %s" ,
181- async ( initialFocus ) => {
182- const { onRestore } = await renderComposer ( initialFocus ) ;
90+ describe ( "stash keyboard scope" , ( ) => {
91+ it . each ( [
92+ { name : "Enter" , key : { key : "Enter" } } ,
93+ { name : "Ctrl+Backspace" , key : { key : "Backspace" , ctrlKey : true } } ,
94+ { name : "Cmd+Backspace" , key : { key : "Backspace" , metaKey : true } } ,
95+ { name : "Escape" , key : { key : "Escape" } } ,
96+ ] ) ( "leaves $name in a dialog input to the dialog" , async ( { key } ) => {
97+ const { onRestore, onDelete, onClose, onDialogKeyDown } = await renderWithDialog ( ) ;
98+ const input = document . querySelector < HTMLInputElement > ( 'input[aria-label="Search commands"]' ) ! ;
99+ await act ( ( ) => input . focus ( ) ) ;
100+ await press ( input , key ) ;
101+ expect ( onRestore ) . not . toHaveBeenCalled ( ) ;
102+ expect ( onDelete ) . not . toHaveBeenCalled ( ) ;
103+ expect ( onClose ) . not . toHaveBeenCalled ( ) ;
104+ expect ( onDialogKeyDown ) . toHaveBeenCalledOnce ( ) ;
105+ } ) ;
106+
107+ it ( "still restores and deletes from the composer editor" , async ( ) => {
108+ const { onRestore, onDelete } = await renderWithDialog ( ) ;
183109 const editor = host . querySelector < HTMLElement > ( '[data-testid="composer-editor"]' ) ! ;
184- expect ( document . activeElement ) . toBe ( editor ) ;
185- await press ( document . activeElement as HTMLElement , { key : "ArrowDown" } ) ;
186- expect ( document . activeElement ) . toBe ( editor ) ;
187- expect (
188- host . querySelector ( '[data-stash-entry="second"]' ) ?. getAttribute ( "data-highlighted" ) ,
189- ) . toBe ( "true" ) ;
190- await press ( document . activeElement as HTMLElement , { key : "ArrowUp" } ) ;
191- expect ( document . activeElement ) . toBe ( editor ) ;
192110 expect ( ( await press ( editor , { key : "Enter" } ) ) . defaultPrevented ) . toBe ( true ) ;
193111 expect ( onRestore ) . toHaveBeenCalledExactlyOnceWith ( entries [ 0 ] ) ;
194- } ,
195- ) ;
196-
197- it . each ( [ "editor" , "other" ] as const ) (
198- "keeps focus in the %s field when the drawer opens" ,
199- async ( initialFocus ) => {
200- await renderComposer ( initialFocus ) ;
201- expect ( document . activeElement ) . toBe (
202- host . querySelector (
203- initialFocus === "editor"
204- ? '[data-testid="composer-editor"]'
205- : 'input[aria-label="Other composer field"]' ,
206- ) ,
207- ) ;
208- } ,
209- ) ;
210-
211- it . each ( [ undefined , "badge" ] as const ) (
212- "uses a drawer button when opening from %s with a disabled editor" ,
213- async ( initialFocus ) => {
214- const { onRestore } = await renderComposer ( initialFocus , true ) ;
215- const first = host . querySelector < HTMLButtonElement > ( '[data-stash-restore="first"]' ) ! ;
216- expect ( document . activeElement ) . toBe ( first ) ;
217- await press ( first , { key : "ArrowDown" } ) ;
218- const second = host . querySelector < HTMLButtonElement > ( '[data-stash-restore="second"]' ) ! ;
219- expect ( document . activeElement ) . toBe ( second ) ;
220- expect ( ( await press ( second , { key : "Enter" } ) ) . defaultPrevented ) . toBe ( false ) ;
221- await act ( ( ) => second . click ( ) ) ;
222- expect ( onRestore ) . toHaveBeenCalledExactlyOnceWith ( entries [ 1 ] ) ;
223- await press ( second , { key : "Escape" } ) ;
224- expect ( host . querySelector ( '[data-composer-stash-drawer="true"]' ) ) . toBeNull ( ) ;
225- expect ( document . activeElement ) . toBe (
226- initialFocus === "badge"
227- ? host . querySelector ( '[data-prompt-stash-badge="true"]' )
228- : document . body ,
229- ) ;
230- } ,
231- ) ;
232-
233- it . each ( [ undefined , "badge" ] as const ) (
234- "keeps editor focus after closing a drawer opened from %s" ,
235- async ( initialFocus ) => {
236- await renderComposer ( initialFocus ) ;
237- const editor = host . querySelector < HTMLElement > ( '[data-testid="composer-editor"]' ) ! ;
238- await press ( editor , { key : "Escape" } ) ;
239- expect ( host . querySelector ( '[data-composer-stash-drawer="true"]' ) ) . toBeNull ( ) ;
240- expect ( document . activeElement ) . toBe ( editor ) ;
241- } ,
242- ) ;
243-
244- it . each ( [
245- { editorDisabled : false , method : "shortcut" } ,
246- { editorDisabled : true , method : "shortcut" } ,
247- { editorDisabled : false , method : "button" } ,
248- { editorDisabled : true , method : "button" } ,
249- ] ) (
250- "keeps drawer navigation after $method deletion with editorDisabled=$editorDisabled" ,
251- async ( { editorDisabled, method } ) => {
252- const { onDelete, onRestore } = await renderComposer ( "badge" , editorDisabled , true ) ;
253- const first = host . querySelector < HTMLButtonElement > ( '[data-stash-restore="first"]' ) ! ;
254- await act ( ( ) => first . focus ( ) ) ;
255- if ( method === "shortcut" ) {
256- await press ( first , { key : "Backspace" , ctrlKey : true } ) ;
257- } else {
258- const remove = host . querySelector < HTMLButtonElement > (
259- '[data-stash-entry="first"] button[aria-label="Delete stashed prompt"]' ,
260- ) ! ;
261- await act ( ( ) => remove . focus ( ) ) ;
262- await press ( remove , { key : "Enter" } ) ;
263- await act ( ( ) => remove . click ( ) ) ;
264- }
112+ expect ( ( await press ( editor , { key : "Backspace" , ctrlKey : true } ) ) . defaultPrevented ) . toBe ( true ) ;
265113 expect ( onDelete ) . toHaveBeenCalledExactlyOnceWith ( entries [ 0 ] ) ;
266- expect ( host . querySelector ( '[data-stash-entry="first"]' ) ) . toBeNull ( ) ;
267- const second = host . querySelector < HTMLButtonElement > ( '[data-stash-restore="second"]' ) ! ;
268- expect ( document . activeElement ) . toBe ( second ) ;
269- expect ( ( await press ( second , { key : "ArrowUp" } ) ) . defaultPrevented ) . toBe ( true ) ;
270- expect ( ( await press ( second , { key : "Enter" } ) ) . defaultPrevented ) . toBe ( false ) ;
271- await act ( ( ) => second . click ( ) ) ;
272- expect ( onRestore ) . toHaveBeenCalledExactlyOnceWith ( entries [ 1 ] ) ;
273- await press ( second , { key : "Backspace" , ctrlKey : true } ) ;
274- expect ( host . querySelector ( '[data-composer-stash-drawer="true"]' ) ) . toBeNull ( ) ;
275- } ,
276- ) ;
277-
278- it . each ( [ "editor" , "drawer" ] ) (
279- "keeps stash navigation, restoration, deletion and dismissal in the %s" ,
280- async ( scope ) => {
281- const { onRestore, onDelete, onClose } = await renderComposer ( ) ;
282- const target = host . querySelector < HTMLElement > (
283- scope === "editor"
284- ? '[data-testid="composer-editor"]'
285- : '[data-composer-stash-drawer="true"]' ,
286- ) ! ;
287- target . tabIndex = - 1 ;
288- await act ( ( ) => target . focus ( ) ) ;
289- expect ( ( await press ( target , { key : "ArrowDown" } ) ) . defaultPrevented ) . toBe ( true ) ;
290- expect (
291- host . querySelector ( '[data-stash-entry="second"]' ) ?. getAttribute ( "data-highlighted" ) ,
292- ) . toBe ( "true" ) ;
293- expect ( ( await press ( target , { key : "ArrowUp" } ) ) . defaultPrevented ) . toBe ( true ) ;
294- expect ( host . querySelector ( '[data-stash-entry="first"]' ) ?. getAttribute ( "data-highlighted" ) ) . toBe (
295- "true" ,
296- ) ;
297- expect ( ( await press ( target , { key : "Enter" } ) ) . defaultPrevented ) . toBe ( true ) ;
298- expect ( onRestore ) . toHaveBeenCalledExactlyOnceWith ( entries [ 0 ] ) ;
299- for ( const modifier of [ { ctrlKey : true } , { metaKey : true } ] ) {
300- expect ( ( await press ( target , { key : "Backspace" , ...modifier } ) ) . defaultPrevented ) . toBe ( true ) ;
301- }
302- expect ( onDelete ) . toHaveBeenCalledTimes ( 2 ) ;
303- expect ( onDelete ) . toHaveBeenLastCalledWith ( entries [ scope === "drawer" ? 1 : 0 ] ) ;
304- await press ( target , { key : "Escape" } ) ;
305- expect ( onClose ) . toHaveBeenCalledOnce ( ) ;
306- } ,
307- ) ;
308-
309- it ( "moves focus between drawer rows and leaves Enter activation to the delete button" , async ( ) => {
310- const { onRestore, onDelete } = await renderComposer ( ) ;
311- const first = host . querySelector < HTMLButtonElement > ( '[data-stash-restore="first"]' ) ! ;
312- await act ( ( ) => first . focus ( ) ) ;
313- await press ( first , { key : "ArrowDown" } ) ;
314- expect ( document . activeElement ) . toBe ( host . querySelector ( '[data-stash-restore="second"]' ) ) ;
315- const remove = host . querySelector < HTMLButtonElement > (
316- '[data-stash-entry="second"] button[aria-label="Delete stashed prompt"]' ,
317- ) ! ;
318- await act ( ( ) => remove . focus ( ) ) ;
319- expect ( ( await press ( remove , { key : "Enter" } ) ) . defaultPrevented ) . toBe ( false ) ;
320- // jsdom does not perform the native button click generated by Enter.
321- await act ( ( ) => remove . click ( ) ) ;
322- expect ( onDelete ) . toHaveBeenCalledExactlyOnceWith ( entries [ 1 ] ) ;
323- expect ( onRestore ) . not . toHaveBeenCalled ( ) ;
324- } ) ;
325-
326- it . each ( [
327- 'input[aria-label="Other composer field"]' ,
328- 'form:nth-child(2) [data-testid="composer-editor"]' ,
329- ] ) ( "ignores stash keys in %s" , async ( selector ) => {
330- const { onRestore, onDelete, onClose } = await renderComposer ( ) ;
331- const target = host . querySelector < HTMLElement > ( selector ) ! ;
332- await act ( ( ) => target . focus ( ) ) ;
333- for ( const key of [ "ArrowUp" , "ArrowDown" , "Enter" , "Escape" , "Backspace" ] ) {
334- expect ( ( await press ( target , { key, ctrlKey : key === "Backspace" } ) ) . defaultPrevented ) . toBe (
335- false ,
336- ) ;
337- }
338- expect ( onRestore ) . not . toHaveBeenCalled ( ) ;
339- expect ( onDelete ) . not . toHaveBeenCalled ( ) ;
340- expect ( onClose ) . not . toHaveBeenCalled ( ) ;
341- expect ( host . querySelector ( '[data-stash-entry="first"]' ) ?. getAttribute ( "data-highlighted" ) ) . toBe (
342- "true" ,
343- ) ;
114+ } ) ;
344115} ) ;
0 commit comments