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

Better types and tests for useKeyProps #2468

Merged
merged 10 commits into from
Dec 30, 2022
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Better types + tests for useKeyProps",
"packageName": "@fluentui-react-native/interactive-hooks",
"email": "[email protected]",
"dependentChangeType": "patch"
}
4 changes: 2 additions & 2 deletions packages/utils/interactive-hooks/jest.config.js
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
const { configureJest } = require('@fluentui-react-native/scripts');
module.exports = configureJest();
const { configureReactNativeJest } = require('@fluentui-react-native/scripts');
module.exports = configureReactNativeJest('win32');
5 changes: 4 additions & 1 deletion packages/utils/interactive-hooks/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,16 @@
},
"devDependencies": {
"@fluentui-react-native/eslint-config-rules": "^0.1.1",
"@fluentui-react-native/test-tools": ">=0.1.1 <1.0.0",
"@office-iss/react-native-win32": "^0.68.0",
"@types/invariant": "^2.2.0",
"@types/jest": "^26.0.0",
"@types/react": "^17.0.2",
"@types/react-native": "^0.68.0",
"react": "17.0.2",
"react-native": "^0.68.0"
"react-native": "^0.68.0",
"react-native-macos": "^0.68.0",
"react-native-windows": "^0.68.0"
},
"peerDependencies": {
"react": "17.0.2",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`Pressable with useKeyProps 1`] = `
<View
accessible={true}
focusable={true}
keyUpEvents={
Array [
Object {
"key": " ",
},
Object {
"key": "Enter",
},
]
}
onBlur={[Function]}
onClick={[Function]}
onFocus={[Function]}
onKeyDown={[Function]}
onKeyUp={[Function]}
onMouseEnter={[Function]}
onMouseLeave={[Function]}
onResponderGrant={[Function]}
onResponderMove={[Function]}
onResponderRelease={[Function]}
onResponderTerminate={[Function]}
onResponderTerminationRequest={[Function]}
onStartShouldSetResponder={[Function]}
/>
`;
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AccessibilityActionEvent, GestureResponderEvent } from 'react-native';
import { KeyPressEvent } from './Pressability/CoreEventTypes';
import { isAccessibilityActionEvent, isGestureResponderEvent, isKeyPressEvent } from './events.types';
import { KeyPressEvent } from '../useKeyProps.types';
import { isAccessibilityActionEvent, isGestureResponderEvent, isKeyPressEvent } from '../events.types';

const createMockEvent = (nativeEvent) => {
return {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import * as React from 'react';
import * as renderer from 'react-test-renderer';
import { Pressable } from 'react-native';
import { useKeyProps } from '../useKeyProps';
import { checkRenderConsistency, checkReRender } from '@fluentui-react-native/test-tools';
import { PressablePropsExtended } from '../usePressableState.types';

const dummyFunction = () => {
console.log('dummy');
};

// Simple wrapper function to let us use `PressablePropsExtended` to fix type errors
const PressableWithDesktopProps = (props: PressablePropsExtended) => {
return <Pressable {...props} />;
};

it('Pressable with useKeyProps', () => {
const keyboardProps = useKeyProps(dummyFunction, ' ', 'Enter');
const tree = renderer.create(<PressableWithDesktopProps {...keyboardProps} />).toJSON();
expect(tree).toMatchSnapshot();
});

it('useKeyProps called twice', () => {
const keyboardProps1 = useKeyProps(dummyFunction, ' ', 'Enter');
const keyboardProps2 = useKeyProps(dummyFunction, ' ', 'Enter');
expect(keyboardProps1).toBe(keyboardProps2);
});

it('Simple Pressable with useKeyProps rendering does not invalidate styling', () => {
const keyboardProps = useKeyProps(dummyFunction, ' ', 'Enter');
checkRenderConsistency(() => <PressableWithDesktopProps {...keyboardProps} />, 2);
});

it('Pressable with useKeyProps re-renders correctly', () => {
const keyboardProps = useKeyProps(dummyFunction, ' ', 'Enter');
checkReRender(() => <PressableWithDesktopProps {...keyboardProps} />, 2);
});
4 changes: 2 additions & 2 deletions packages/utils/interactive-hooks/src/events.types.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { AccessibilityActionEvent, GestureResponderEvent } from 'react-native';
import { KeyPressEvent, MouseEvent } from './Pressability/CoreEventTypes';
import { AccessibilityActionEvent, GestureResponderEvent, MouseEvent } from 'react-native';
import { KeyPressEvent } from './useKeyProps.types';

export type InteractionEvent = GestureResponderEvent | MouseEvent | KeyPressEvent | AccessibilityActionEvent;

Expand Down
3 changes: 1 addition & 2 deletions packages/utils/interactive-hooks/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ export type {
export type {
BlurEvent,
FocusEvent,
KeyPressEvent,
Layout,
LayoutEvent,
MouseEvent,
Expand All @@ -56,8 +55,8 @@ export type {
TextLayout,
TextLayoutEvent,
} from './Pressability/CoreEventTypes';
export type { KeyPressEvent, KeyCallback, KeyPressProps } from './useKeyProps.types';
export { preferKeyDownForKeyEvents, useKeyCallback, useKeyDownProps, useKeyProps, useKeyUpProps } from './useKeyProps';
export type { KeyCallback, KeyPressProps } from './useKeyProps';
export { useOnPressWithFocus } from './useOnPressWithFocus';
export type { OnPressCallback, OnPressWithFocusCallback } from './useOnPressWithFocus';
export { getAccessibilityState } from './getAccessibilityState';
18 changes: 0 additions & 18 deletions packages/utils/interactive-hooks/src/isModifierKey.ts

This file was deleted.

79 changes: 0 additions & 79 deletions packages/utils/interactive-hooks/src/useKeyProps.macos.ts

This file was deleted.

Loading