@testing-library/react-native 12.1.3 → 12.2.0

package/src/user-event/utils/__tests__/dispatch-event.test.tsx

@@ -0,0 +1,41 @@
+import * as React from 'react';
+import { Text } from 'react-native';
+import render from '../../../render';
+import { dispatchEvent } from '../dispatch-event';
+import { EventBuilder } from '../../event-builder';
+
+const TOUCH_EVENT = EventBuilder.Common.touch();
+
+describe('dispatchEvent', () => {
+  it('does dispatch event', () => {
+    const onPress = jest.fn();
+    const screen = render(<Text testID="text" onPress={onPress} />);
+
+    dispatchEvent(screen.getByTestId('text'), 'press', TOUCH_EVENT);
+    expect(onPress).toHaveBeenCalledTimes(1);
+  });
+
+  it('does not dispatch event to parent host component', () => {
+    const onPressParent = jest.fn();
+    const screen = render(
+      <Text onPress={onPressParent}>
+        <Text testID="text" />
+      </Text>
+    );
+
+    dispatchEvent(screen.getByTestId('text'), 'press', TOUCH_EVENT);
+    expect(onPressParent).not.toHaveBeenCalled();
+  });
+
+  it('does NOT throw if no handler found', () => {
+    const screen = render(
+      <Text>
+        <Text testID="text" />
+      </Text>
+    );
+
+    expect(() =>
+      dispatchEvent(screen.getByTestId('text'), 'press', TOUCH_EVENT)
+    ).not.toThrow();
+  });
+});

package/src/user-event/utils/content-size.ts

@@ -0,0 +1,25 @@
+export interface ContentSize {
+  width: number;
+  height: number;
+}
+
+/**
+ * Simple function for getting mock the size of given text.
+ *
+ * It works by calculating height based on number of lines and width based on
+ * the longest line length. It does not take into account font size, font
+ * family, as well as different letter sizes.
+ *
+ * @param text text to be measure
+ * @returns width and height of the text
+ */
+
+export function getTextContentSize(text: string): ContentSize {
+  const lines = text.split('\n');
+  const maxLineLength = Math.max(...lines.map((line) => line.length));
+
+  return {
+    width: maxLineLength * 5,
+    height: lines.length * 16,
+  };
+}

package/src/user-event/utils/dispatch-event.ts

@@ -0,0 +1,38 @@
+import { ReactTestInstance } from 'react-test-renderer';
+import act from '../../act';
+
+/**
+ * Basic dispatch event function used by User Event module.
+ *
+ * @param element element trigger event on
+ * @param eventName name of the event
+ * @param event event payload
+ */
+export function dispatchEvent(
+  element: ReactTestInstance,
+  eventName: string,
+  event: unknown
+) {
+  const handler = getEventHandler(element, eventName);
+  if (!handler) {
+    return;
+  }
+
+  act(() => {
+    handler(event);
+  });
+}
+
+function getEventHandler(element: ReactTestInstance, eventName: string) {
+  const handleName = getEventHandlerName(eventName);
+  const handle = element.props[handleName] as unknown;
+  if (typeof handle !== 'function') {
+    return undefined;
+  }
+
+  return handle;
+}
+
+function getEventHandlerName(eventName: string) {
+  return `on${eventName.charAt(0).toUpperCase()}${eventName.slice(1)}`;
+}

package/src/user-event/utils/index.ts

@@ -1,2 +1,5 @@
-export * from './events';
+export * from './content-size';
+export * from './dispatch-event';
+export * from './text-range';
 export * from './wait';
+export * from './warn-about-real-timers';

package/src/user-event/utils/text-range.ts

@@ -0,0 +1,11 @@
+export interface TextRange {
+  start: number;
+  end: number;
+}
+
+export function getTextRange(text: string): TextRange {
+  return {
+    start: text.length,
+    end: text.length,
+  };
+}

package/src/user-event/{press/utils/warnAboutRealTimers.ts → utils/warn-about-real-timers.ts}

@@ -1,4 +1,11 @@
-export const warnAboutRealTimers = () => {
+import { jestFakeTimersAreEnabled } from '../../helpers/timers';
+
+export const warnAboutRealTimersIfNeeded = () => {
+  const areFakeTimersEnabled = jestFakeTimersAreEnabled();
+  if (areFakeTimersEnabled) {
+    return;
+  }
+
   // eslint-disable-next-line no-console
   console.warn(`It is recommended to use userEvent with fake timers
 Some events involve duration so your tests may take a long time to run.

package/website/.docusaurus/DONT-EDIT-THIS-FOLDER

@@ -0,0 +1,5 @@
+This folder stores temp files that Docusaurus' client bundler accesses.
+
+DO NOT hand-modify files in this folder because they will be overwritten in the
+next build. You can clear all build artifacts (including this folder) with the
+`docusaurus clear` command.

package/website/.docusaurus/client-modules.js

@@ -0,0 +1,6 @@
+export default [
+  require('/Users/maciej/Development/OpenSource/RNTL/website/node_modules/infima/dist/css/default/default.css'),
+  require('/Users/maciej/Development/OpenSource/RNTL/website/node_modules/@docusaurus/theme-classic/lib/prism-include-languages'),
+  require('/Users/maciej/Development/OpenSource/RNTL/website/node_modules/@docusaurus/theme-classic/lib/nprogress'),
+  require('/Users/maciej/Development/OpenSource/RNTL/website/src/css/custom.css'),
+];

package/website/.docusaurus/codeTranslations.json

@@ -0,0 +1 @@
+{}

package/website/.docusaurus/docusaurus-plugin-content-blog/default/blog-post-list-prop-default.json

@@ -0,0 +1,4 @@
+{
+  "title": "Recent posts",
+  "items": []
+}

package/website/.docusaurus/docusaurus-plugin-content-blog/default/plugin-route-context-module-100.json

@@ -0,0 +1,4 @@
+{
+  "name": "docusaurus-plugin-content-blog",
+  "id": "default"
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json

@@ -0,0 +1,4 @@
+{
+  "name": "docusaurus-plugin-content-docs",
+  "id": "default"
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-api-md-c82.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "api",
+  "id": "api",
+  "title": "API",
+  "description": "Table of contents:",
+  "source": "@site/docs/API.md",
+  "sourceDirName": ".",
+  "slug": "/api",
+  "permalink": "/react-native-testing-library/docs/api",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/API.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "api",
+    "title": "API"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "FAQ",
+    "permalink": "/react-native-testing-library/docs/faq"
+  },
+  "next": {
+    "title": "Queries",
+    "permalink": "/react-native-testing-library/docs/api-queries"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-eslint-p-llugin-testing-library-md-d24.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "eslint-plugin-testing-library",
+  "id": "eslint-plugin-testing-library",
+  "title": "ESLint Plugin Testing Library Compatibility",
+  "description": "Most of the rules of the eslint-plugin-testing-library are compatible with this library except the following:",
+  "source": "@site/docs/EslintPLluginTestingLibrary.md",
+  "sourceDirName": ".",
+  "slug": "/eslint-plugin-testing-library",
+  "permalink": "/react-native-testing-library/docs/eslint-plugin-testing-library",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/EslintPLluginTestingLibrary.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "eslint-plugin-testing-library",
+    "title": "ESLint Plugin Testing Library Compatibility"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "How Should I Query?",
+    "permalink": "/react-native-testing-library/docs/how-should-i-query"
+  },
+  "next": {
+    "title": "Testing Environment",
+    "permalink": "/react-native-testing-library/docs/testing-env"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-faq-md-ad8.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "faq",
+  "id": "faq",
+  "title": "FAQ",
+  "description": "Can I test native features of React Native apps?",
+  "source": "@site/docs/FAQ.md",
+  "sourceDirName": ".",
+  "slug": "/faq",
+  "permalink": "/react-native-testing-library/docs/faq",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/FAQ.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "faq",
+    "title": "FAQ"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "Getting Started",
+    "permalink": "/react-native-testing-library/docs/getting-started"
+  },
+  "next": {
+    "title": "API",
+    "permalink": "/react-native-testing-library/docs/api"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-getting-started-md-8a6.json

@@ -0,0 +1,23 @@
+{
+  "unversionedId": "getting-started",
+  "id": "getting-started",
+  "title": "Getting Started",
+  "description": "The problem",
+  "source": "@site/docs/GettingStarted.md",
+  "sourceDirName": ".",
+  "slug": "/getting-started",
+  "permalink": "/react-native-testing-library/docs/getting-started",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/GettingStarted.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "getting-started",
+    "title": "Getting Started"
+  },
+  "sidebar": "docs",
+  "next": {
+    "title": "FAQ",
+    "permalink": "/react-native-testing-library/docs/faq"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-how-should-i-query-md-f2d.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "how-should-i-query",
+  "id": "how-should-i-query",
+  "title": "How Should I Query?",
+  "description": "Priority",
+  "source": "@site/docs/HowShouldIQuery.md",
+  "sourceDirName": ".",
+  "slug": "/how-should-i-query",
+  "permalink": "/react-native-testing-library/docs/how-should-i-query",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/HowShouldIQuery.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "how-should-i-query",
+    "title": "How Should I Query?"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "Troubleshooting",
+    "permalink": "/react-native-testing-library/docs/troubleshooting"
+  },
+  "next": {
+    "title": "ESLint Plugin Testing Library Compatibility",
+    "permalink": "/react-native-testing-library/docs/eslint-plugin-testing-library"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-migration-v-11-md-add.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "migration-v11",
+  "id": "migration-v11",
+  "title": "Migration to 11.0",
+  "description": "Migration to React Native Testing Library version 11 from version 9.x or 10.x should be a relatively easy task due small amount of breaking changes.",
+  "source": "@site/docs/MigrationV11.md",
+  "sourceDirName": ".",
+  "slug": "/migration-v11",
+  "permalink": "/react-native-testing-library/docs/migration-v11",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/MigrationV11.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "migration-v11",
+    "title": "Migration to 11.0"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "Migration to 12.0",
+    "permalink": "/react-native-testing-library/docs/migration-v12"
+  },
+  "next": {
+    "title": "Migration to 9.0",
+    "permalink": "/react-native-testing-library/docs/migration-v9"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-migration-v-12-md-14f.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "migration-v12",
+  "id": "migration-v12",
+  "title": "Migration to 12.0",
+  "description": "React Native Testing Library 12 introduces a handful of breaking changes compared to 11.x versions. We believe they were necessary to improve the experience using the library and help the users fall into the pit of success when writing meaningful tests. You will find migration instructions for each and every change described below.",
+  "source": "@site/docs/MigrationV12.md",
+  "sourceDirName": ".",
+  "slug": "/migration-v12",
+  "permalink": "/react-native-testing-library/docs/migration-v12",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/MigrationV12.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "migration-v12",
+    "title": "Migration to 12.0"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "Understanding Act function",
+    "permalink": "/react-native-testing-library/docs/understanding-act"
+  },
+  "next": {
+    "title": "Migration to 11.0",
+    "permalink": "/react-native-testing-library/docs/migration-v11"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-migration-v-2-md-698.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "migration-v2",
+  "id": "migration-v2",
+  "title": "Migration to 2.0",
+  "description": "This guide describes steps necessary to migrate from React Native Testing Library v1.x to v2.0.",
+  "source": "@site/docs/MigrationV2.md",
+  "sourceDirName": ".",
+  "slug": "/migration-v2",
+  "permalink": "/react-native-testing-library/docs/migration-v2",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/MigrationV2.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "migration-v2",
+    "title": "Migration to 2.0"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "Migration to 7.0",
+    "permalink": "/react-native-testing-library/docs/migration-v7"
+  },
+  "next": {
+    "title": "React Navigation",
+    "permalink": "/react-native-testing-library/docs/react-navigation"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-migration-v-7-md-6bb.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "migration-v7",
+  "id": "migration-v7",
+  "title": "Migration to 7.0",
+  "description": "We renamed the react-native-testing-library npm package to @testing-library/react-native, officially joining the \"Testing Library\" family 🎉.",
+  "source": "@site/docs/MigrationV7.md",
+  "sourceDirName": ".",
+  "slug": "/migration-v7",
+  "permalink": "/react-native-testing-library/docs/migration-v7",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/MigrationV7.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "migration-v7",
+    "title": "Migration to 7.0"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "Migration to 9.0",
+    "permalink": "/react-native-testing-library/docs/migration-v9"
+  },
+  "next": {
+    "title": "Migration to 2.0",
+    "permalink": "/react-native-testing-library/docs/migration-v2"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-migration-v-9-md-f69.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "migration-v9",
+  "id": "migration-v9",
+  "title": "Migration to 9.0",
+  "description": "Version 7.0 brought React Native Testing Library into the @testing-library family. Since it has been implemented independently from its web counterpart – the React Testing Library – there are some differences in the API and behavior. Version 9.0 solves several of these problems.",
+  "source": "@site/docs/MigrationV9.md",
+  "sourceDirName": ".",
+  "slug": "/migration-v9",
+  "permalink": "/react-native-testing-library/docs/migration-v9",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/MigrationV9.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "migration-v9",
+    "title": "Migration to 9.0"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "Migration to 11.0",
+    "permalink": "/react-native-testing-library/docs/migration-v11"
+  },
+  "next": {
+    "title": "Migration to 7.0",
+    "permalink": "/react-native-testing-library/docs/migration-v7"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-queries-md-7ad.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "api-queries",
+  "id": "api-queries",
+  "title": "Queries",
+  "description": "Table of contents:",
+  "source": "@site/docs/Queries.md",
+  "sourceDirName": ".",
+  "slug": "/api-queries",
+  "permalink": "/react-native-testing-library/docs/api-queries",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/Queries.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "api-queries",
+    "title": "Queries"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "API",
+    "permalink": "/react-native-testing-library/docs/api"
+  },
+  "next": {
+    "title": "User Event",
+    "permalink": "/react-native-testing-library/docs/user-event"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-react-navigation-md-1bd.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "react-navigation",
+  "id": "react-navigation",
+  "title": "React Navigation",
+  "description": "This section deals with integrating @testing-library/react-native with react-navigation, using Jest.",
+  "source": "@site/docs/ReactNavigation.md",
+  "sourceDirName": ".",
+  "slug": "/react-navigation",
+  "permalink": "/react-native-testing-library/docs/react-navigation",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/ReactNavigation.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "react-navigation",
+    "title": "React Navigation"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "Migration to 2.0",
+    "permalink": "/react-native-testing-library/docs/migration-v2"
+  },
+  "next": {
+    "title": "Redux Integration",
+    "permalink": "/react-native-testing-library/docs/redux-integration"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-redux-integration-md-77b.json

@@ -0,0 +1,23 @@
+{
+  "unversionedId": "redux-integration",
+  "id": "redux-integration",
+  "title": "Redux Integration",
+  "description": "This section deals with testing RN applications developed with Redux. We will be developing a simple TODO application capable of adding and removing an item. Once included, the timestamp is included.",
+  "source": "@site/docs/ReduxIntegration.md",
+  "sourceDirName": ".",
+  "slug": "/redux-integration",
+  "permalink": "/react-native-testing-library/docs/redux-integration",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/ReduxIntegration.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "redux-integration",
+    "title": "Redux Integration"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "React Navigation",
+    "permalink": "/react-native-testing-library/docs/react-navigation"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-testing-environment-md-1c6.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "testing-env",
+  "id": "testing-env",
+  "title": "Testing Environment",
+  "description": "This document is intended for more advanced audience. You should be able to write integration or component tests without reading this.",
+  "source": "@site/docs/TestingEnvironment.md",
+  "sourceDirName": ".",
+  "slug": "/testing-env",
+  "permalink": "/react-native-testing-library/docs/testing-env",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/TestingEnvironment.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "testing-env",
+    "title": "Testing Environment"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "ESLint Plugin Testing Library Compatibility",
+    "permalink": "/react-native-testing-library/docs/eslint-plugin-testing-library"
+  },
+  "next": {
+    "title": "Understanding Act function",
+    "permalink": "/react-native-testing-library/docs/understanding-act"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-troubleshooting-md-01d.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "troubleshooting",
+  "id": "troubleshooting",
+  "title": "Troubleshooting",
+  "description": "This guide describes common issues found by users when integrating React Native Test Library to their projects.",
+  "source": "@site/docs/Troubleshooting.md",
+  "sourceDirName": ".",
+  "slug": "/troubleshooting",
+  "permalink": "/react-native-testing-library/docs/troubleshooting",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/Troubleshooting.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "troubleshooting",
+    "title": "Troubleshooting"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "User Event",
+    "permalink": "/react-native-testing-library/docs/user-event"
+  },
+  "next": {
+    "title": "How Should I Query?",
+    "permalink": "/react-native-testing-library/docs/how-should-i-query"
+  }
+}

package/website/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-understanding-act-md-aa9.json

@@ -0,0 +1,27 @@
+{
+  "unversionedId": "understanding-act",
+  "id": "understanding-act",
+  "title": "Understanding Act function",
+  "description": "When writing RNTL tests one of the things that confuses developers the most are cryptic act() function errors logged into console. In this article I will try to build an understanding of the purpose and behaviour of act() so you can build your tests with more confidence.",
+  "source": "@site/docs/UnderstandingAct.md",
+  "sourceDirName": ".",
+  "slug": "/understanding-act",
+  "permalink": "/react-native-testing-library/docs/understanding-act",
+  "draft": false,
+  "editUrl": "https://github.com/callstack/react-native-testing-library/blob/main/website/docs/UnderstandingAct.md",
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "id": "understanding-act",
+    "title": "Understanding Act function"
+  },
+  "sidebar": "docs",
+  "previous": {
+    "title": "Testing Environment",
+    "permalink": "/react-native-testing-library/docs/testing-env"
+  },
+  "next": {
+    "title": "Migration to 12.0",
+    "permalink": "/react-native-testing-library/docs/migration-v12"
+  }
+}