Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: backhandler api update #2744

Merged
merged 6 commits into from
Feb 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/react-native-aria/interactions/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ export {
export {
keyboardDismissHandlerManager,
useKeyboardDismissable,
useBackHandler,
} from './useKeyboardDismisssable';

export { useBackHandler } from './useBackHandler';
7 changes: 0 additions & 7 deletions packages/react-native-aria/interactions/src/index.web.ts

This file was deleted.

27 changes: 27 additions & 0 deletions packages/react-native-aria/interactions/src/useBackHandler.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { useEffect, useRef } from 'react';
import { BackHandler, NativeEventSubscription } from 'react-native';

type IParams = {
enabled?: boolean;
callback: () => any;
};

export function useBackHandler({ enabled, callback }: IParams) {
const backHandlerRef = useRef<NativeEventSubscription | null>(null);

useEffect(() => {
const backHandler = () => {
callback();
return true;
};
if (enabled) {
backHandlerRef.current = BackHandler.addEventListener(
'hardwareBackPress',
backHandler
);
} else {
backHandlerRef.current?.remove();
}
return () => backHandlerRef.current?.remove();
}, [enabled, callback]);
}
21 changes: 21 additions & 0 deletions packages/react-native-aria/interactions/src/useBackHandler.web.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { useEffect } from 'react';

type IParams = {
enabled?: boolean;
callback: () => any;
};

export function useBackHandler({ enabled, callback }: IParams) {
useEffect(() => {
const handleEscape = (e: KeyboardEvent) => {
if (e.key === 'Escape') {
callback();
}
};

document?.body?.addEventListener?.('keyup', handleEscape);
return () => {
document?.body?.removeEventListener?.('keyup', handleEscape);
};
}, [enabled, callback]);
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import React from 'react';
import { useEffect } from 'react';
import { BackHandler, Platform } from 'react-native';
import { useBackHandler } from './useBackHandler';

type IParams = {
enabled?: boolean;
Expand All @@ -27,7 +26,7 @@ export const keyboardDismissHandlerManager = {
* Handles attaching callback for Escape key listener on web and Back button listener on Android
*/
export const useKeyboardDismissable = ({ enabled, callback }: IParams) => {
React.useEffect(() => {
useEffect(() => {
let cleanupFn = () => {};
if (enabled) {
cleanupFn = keyboardDismissHandlerManager.push(callback);
Expand All @@ -41,32 +40,3 @@ export const useKeyboardDismissable = ({ enabled, callback }: IParams) => {

useBackHandler({ enabled, callback });
};

export function useBackHandler({ enabled, callback }: IParams) {
useEffect(() => {
if (Platform.OS === 'web') {
const handleEscape = (e: KeyboardEvent) => {
if (e.key === 'Escape') {
callback();
}
};

document?.body?.addEventListener?.('keyup', handleEscape);
return () => {
document?.body?.removeEventListener?.('keyup', handleEscape);
};
} else {
let backHandler = () => {
callback();
return true;
};
if (enabled) {
BackHandler.addEventListener('hardwareBackPress', backHandler);
} else {
BackHandler.removeEventListener('hardwareBackPress', backHandler);
}
return () =>
BackHandler.removeEventListener('hardwareBackPress', backHandler);
}
}, [enabled, callback]);
}
27 changes: 27 additions & 0 deletions packages/unstyled/hooks/src/use-back-handler/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { useEffect, useRef } from 'react';
import { BackHandler, type NativeEventSubscription } from 'react-native';

type IParams = {
enabled?: boolean;
callback: () => any;
};

export function useBackHandler({ enabled, callback }: IParams) {
const backHandlerRef = useRef<NativeEventSubscription | null>(null);

useEffect(() => {
const backHandler = () => {
callback();
return true;
};
if (enabled) {
backHandlerRef.current = BackHandler.addEventListener(
'hardwareBackPress',
backHandler
);
} else {
backHandlerRef.current?.remove();
}
return () => backHandlerRef.current?.remove();
}, [enabled, callback]);
}
21 changes: 21 additions & 0 deletions packages/unstyled/hooks/src/use-back-handler/index.web.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { useEffect } from 'react';

type IParams = {
enabled?: boolean;
callback: () => any;
};

export function useBackHandler({ enabled, callback }: IParams) {
useEffect(() => {
const handleEscape = (e: KeyboardEvent) => {
if (e.key === 'Escape') {
callback();
}
};

document?.body?.addEventListener?.('keyup', handleEscape);
return () => {
document?.body?.removeEventListener?.('keyup', handleEscape);
};
}, [enabled, callback]);
}
32 changes: 1 addition & 31 deletions packages/unstyled/hooks/src/use-keyboard-dismissable/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import React from 'react';
import { useEffect } from 'react';
import { BackHandler, Platform } from 'react-native';
import { useBackHandler } from '../use-back-handler';

type IParams = {
enabled?: boolean;
Expand Down Expand Up @@ -41,32 +40,3 @@ export const useKeyboardDismissable = ({ enabled, callback }: IParams) => {

useBackHandler({ enabled, callback });
};

export function useBackHandler({ enabled, callback }: IParams) {
useEffect(() => {
if (Platform.OS === 'web') {
const handleEscape = (e: KeyboardEvent) => {
if (e.key === 'Escape') {
callback();
}
};

document?.body?.addEventListener?.('keyup', handleEscape);
return () => {
document?.body?.removeEventListener?.('keyup', handleEscape);
};
} else {
const backHandler = () => {
callback();
return true;
};
if (enabled) {
BackHandler.addEventListener('hardwareBackPress', backHandler);
} else {
BackHandler.removeEventListener('hardwareBackPress', backHandler);
}
return () =>
BackHandler.removeEventListener('hardwareBackPress', backHandler);
}
}, [enabled, callback]);
}
22 changes: 12 additions & 10 deletions packages/unstyled/react-native-aria/src/useKeyboardDismisssable.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import React from 'react';
import { useEffect } from 'react';
import { BackHandler } from 'react-native';
import { useEffect, useRef } from 'react';
import { BackHandler, NativeEventSubscription } from 'react-native';

type IParams = {
enabled?: boolean;
Expand All @@ -27,7 +26,7 @@ export const keyboardDismissHandlerManager = {
* Handles attaching callback for Escape key listener on web and Back button listener on Android
*/
export const useKeyboardDismissable = ({ enabled, callback }: IParams) => {
React.useEffect(() => {
useEffect(() => {
let cleanupFn = () => {};
if (enabled) {
cleanupFn = keyboardDismissHandlerManager.push(callback);
Expand All @@ -41,19 +40,22 @@ export const useKeyboardDismissable = ({ enabled, callback }: IParams) => {

useBackHandler({ enabled, callback });
};

export function useBackHandler({ enabled, callback }: IParams) {
const backHandlerRef = useRef<NativeEventSubscription | null>(null);

useEffect(() => {
let backHandler = () => {
const backHandler = () => {
callback();
return true;
};
if (enabled) {
BackHandler.addEventListener('hardwareBackPress', backHandler);
backHandlerRef.current = BackHandler.addEventListener(
'hardwareBackPress',
backHandler
);
} else {
BackHandler.removeEventListener('hardwareBackPress', backHandler);
backHandlerRef.current?.remove();
}
return () =>
BackHandler.removeEventListener('hardwareBackPress', backHandler);
return () => backHandlerRef.current?.remove();
}, [enabled, callback]);
}