44 ComponentDidAppearEvent ,
55 ComponentDidDisappearEvent ,
66 CommandCompletedEvent ,
7+ ScreenPoppedEvent ,
78 ModalDismissedEvent ,
89 BottomTabSelectedEvent ,
910 NavigationButtonPressedEvent ,
@@ -18,6 +19,7 @@ import {
1819 useNavigationCommand ,
1920 useNavigationCommandComplete ,
2021 useNavigationModalDismiss ,
22+ useNavigationScreenPop ,
2123 useNavigationBottomTabSelect ,
2224 useNavigationButtonPress ,
2325 useNavigationSearchBarUpdate ,
@@ -385,6 +387,97 @@ describe('useNavigationCommandComplete', () => {
385387 } )
386388} )
387389
390+ describe ( 'useNavigationScreenPop' , ( ) => {
391+ let triggerEvent : ( event : ScreenPoppedEvent ) => void
392+ let mockRemoveSubscription : ( ) => void
393+ let mockHandler : ( ) => void
394+
395+ beforeEach ( ( ) => {
396+ mockHandler = jest . fn ( ( ) => { } )
397+ mockRemoveSubscription = jest . fn ( )
398+
399+ Navigation . events = jest . fn ( ) . mockReturnValue ( {
400+ registerScreenPoppedListener : jest . fn ( callback => {
401+ triggerEvent = callback
402+
403+ return { remove : mockRemoveSubscription }
404+ } ) ,
405+ } )
406+ } )
407+
408+ it ( 'should remove the event listener on unmount' , ( ) => {
409+ const { result, unmount } = renderHook ( ( ) => {
410+ useNavigationScreenPop ( ( ) => { } )
411+ } )
412+
413+ unmount ( )
414+
415+ expect ( mockRemoveSubscription ) . toBeCalledTimes ( 1 )
416+
417+ expect ( result . current ) . toBeUndefined ( )
418+ expect ( result . error ) . toBeUndefined ( )
419+ } )
420+
421+ it ( 'should never call the handler if no event was triggered' , ( ) => {
422+ const { result } = renderHook ( ( ) => {
423+ useNavigationScreenPop ( ( ) => { } )
424+ } )
425+
426+ expect ( mockHandler ) . toBeCalledTimes ( 0 )
427+
428+ expect ( result . current ) . toBeUndefined ( )
429+ expect ( result . error ) . toBeUndefined ( )
430+ } )
431+
432+ it ( 'should call handler twice when componentId is not provided' , ( ) => {
433+ const { result } = renderHook ( ( ) => {
434+ useNavigationScreenPop ( mockHandler )
435+ } )
436+
437+ const event1 = { componentId : 'COMPONENT_ID_1' }
438+ triggerEvent ( event1 )
439+
440+ const event2 = { componentId : 'COMPONENT_ID_2' }
441+ triggerEvent ( event2 )
442+
443+ expect ( mockHandler ) . toBeCalledTimes ( 2 )
444+ expect ( mockHandler ) . toHaveBeenNthCalledWith ( 1 , event1 )
445+ expect ( mockHandler ) . toHaveBeenNthCalledWith ( 2 , event2 )
446+
447+ expect ( result . current ) . toBeUndefined ( )
448+ expect ( result . error ) . toBeUndefined ( )
449+ } )
450+
451+ it ( 'should call handler once if componentId provided' , ( ) => {
452+ const { result } = renderHook ( ( ) => {
453+ useNavigationScreenPop ( mockHandler , 'COMPONENT_ID_1' )
454+ } )
455+
456+ const event = { componentId : 'COMPONENT_ID_1' }
457+ triggerEvent ( event )
458+
459+ expect ( mockHandler ) . toBeCalledTimes ( 1 )
460+ expect ( mockHandler ) . toBeCalledWith ( event )
461+
462+ expect ( result . current ) . toBeUndefined ( )
463+ expect ( result . error ) . toBeUndefined ( )
464+ } )
465+
466+ it ( 'should never call the handler if componentId does not match' , ( ) => {
467+ const { result } = renderHook ( ( ) => {
468+ useNavigationScreenPop ( mockHandler , 'COMPONENT_ID_1' )
469+ } )
470+
471+ const event = { componentId : 'COMPONENT_ID_2' }
472+ triggerEvent ( event )
473+
474+ expect ( mockHandler ) . toBeCalledTimes ( 0 )
475+
476+ expect ( result . current ) . toBeUndefined ( )
477+ expect ( result . error ) . toBeUndefined ( )
478+ } )
479+ } )
480+
388481describe ( 'useNavigationModalDismiss' , ( ) => {
389482 let triggerEvent : ( event : ModalDismissedEvent ) => void
390483 let mockRemoveSubscription : ( ) => void
0 commit comments