React Native Owl

https://nearform.com/open-source/react-native-owl/docs/
Admin
React Native Owl is a screenshot testing framework for React Native applications that enables visual...
Tokens:8,295
Snippets:65
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Install React Native OWL

Source: https://nearform.com/open-source/react-native-owl/docs/introduction/getting-started

Installs the react-native-owl package as a development dependency using either npm or yarn.

```bash
npm install --save-dev react-native-owl
```

```bash
yarn add --dev react-native-owl
```

--------------------------------

### Run React Native OWL Tests

Source: https://nearform.com/open-source/react-native-owl/docs/introduction/getting-started

Executes screenshot tests against baseline images for the specified platform. If baseline images do not exist, they will be created. Requires the simulator to be manually started.

```bash
npx owl test --platform ios
```

```bash
yarn owl test --platform ios
```

--------------------------------

### React Native OWL Screenshot Test Example

Source: https://nearform.com/open-source/react-native-owl/docs/introduction/getting-started

An example TypeScript file (`.owl.tsx`) demonstrating how to use `takeScreenshot` and `press` from `react-native-owl` to perform screenshot tests and compare them against baseline images.

```typescript
import { press, takeScreenshot } from 'react-native-owl';

describe('App.tsx', () => {
  it('takes a screenshot of the first screen', async () => {
    const screen = await takeScreenshot('homescreen');

    expect(screen).toMatchBaseline();
  });

  it('presses a button, then takes a screenshot', async () => {
    await press('button')

    const screen = await takeScreenshot('afterButtonPress');

    expect(screen).toMatchBaseline();
  });
});
```

--------------------------------

### Install ts-jest for TypeScript Jest Configuration

Source: https://nearform.com/open-source/react-native-owl/docs/introduction/getting-started

Installs the `ts-jest` package as a development dependency, required for using Jest with TypeScript projects.

```bash
npm install --save-dev ts-jest
```

```bash
yarn add --dev ts-jest
```

--------------------------------

### Example owl.config.json Configuration

Source: https://nearform.com/open-source/react-native-owl/docs/introduction/config-file

This JSON configuration file demonstrates how to set up parameters for both iOS and Android builds within React Native Owl. It specifies essential details like the iOS workspace and scheme, and the Android package name.

```json
{
  "ios": {
    "workspace": "ios/OwlDemoApp.xcworkspace",
    "scheme": "OwlDemoApp",
    "device": "iPhone 13 Pro"
  },
  "android": {
    "packageName": "com.owldemoapp"
  }
}
```

--------------------------------

### Build React Native App for Testing

Source: https://nearform.com/open-source/react-native-owl/docs/introduction/getting-started

Builds the React Native application for the specified platform (e.g., iOS) using the `owl build` command with either npm or yarn.

```bash
npx owl build --platform ios
```

```bash
yarn owl build --platform ios
```

--------------------------------

### Example test failure report output

Source: https://nearform.com/open-source/react-native-owl/docs/cli/testing-the-app

Illustrates the typical output format when react-native-owl tests fail due to differences in `toMatchBaseline()` expectations. It includes the report generation status and the URI to the generated HTML report.

```text
...  
[OWL - CLI] Generating Report  
[OWL - CLI] Report was built at /Users/username/Code/FormidableLabs/react-native-owl/example/.owl/report/index.html  
...  
```

--------------------------------

### Visual Regression Testing for Android using GitHub Actions

Source: https://nearform.com/open-source/react-native-owl/docs/ci/github-actions

This workflow automates visual regression tests for the React Native Owl library on Android. It checks out code, sets up Node.js, installs dependencies, caches Gradle dependencies, configures an Android emulator, builds the Owl library, runs tests, and uploads test artifacts on failure. Requires a macOS runner.

```yaml
name: Visual Regression - Android  
  
on: [pull_request]  
  
jobs:
  run-visual-regression-android:
    runs-on: macos-14  

    steps:
      - uses: actions/checkout@v4  

      - name: Set up Node  
        uses: actions/setup-node@v4  
        with:  
          node-version: 20  
          cache: 'yarn'  

      - name: Install Dependencies  
        run: yarn install --frozen-lockfile  

      - uses: actions/cache@v4  
        with:  
          path: |
            ~/.gradle/caches  
            ~/.gradle/wrapper  
          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}  
          restore-keys: |
            ${{ runner.os }}-gradle-  

      - name: SKDs - download required images  
        run: $ANDROID_HOME/tools/bin/sdkmanager "system-images;android-30;default;x86_64"  

      - name: SDKs - accept licenses  
        run: y | $ANDROID_HOME/tools/bin/sdkmanager --licenses  

      - name: Emulator - Create  
        run: $ANDROID_HOME/tools/bin/avdmanager create avd -n Pixel_API_30 --device 'Nexus 5X' --package "system-images;android-30;default;x86_64" --sdcard 512M  

      - name: Emulator - Boot  
        run: $ANDROID_HOME/emulator/emulator -memory 4096 -avd Pixel_API_30 -wipe-data -no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim &  

      - name: ADB Wait For Device  
        run: adb wait-for-any-device  
        timeout-minutes: 3  

      - name: Run Owl Build  
        run: yarn owl:build:android  

      - name: Run Owl Test  
        run: yarn owl:test:android  

      - name: Store screenshots as artifacts  
        uses: actions/upload-artifact@v4  
        if: failure()  
        with:  
          name: owl-screenshots  
          path: ./.owl  

```

--------------------------------

### Configure Jest to Use ts-jest Preset

Source: https://nearform.com/open-source/react-native-owl/docs/introduction/getting-started

Updates the Jest configuration to use the `ts-jest` preset, enabling TypeScript support for tests. This can be done either in `jest.config.js` or `package.json`.

```javascript
"preset": "ts-jest"
```

```javascript
{
  "jest": {
    "preset": "ts-jest"
  }
}
```

--------------------------------

### Update React Native OWL Baseline Images

Source: https://nearform.com/open-source/react-native-owl/docs/introduction/getting-started

Updates the baseline screenshot images for the specified platform. This command is used when intentional changes have been made to the UI and the baseline needs to reflect the new state.

```bash
npx owl test --platform ios --update
```

```bash
yarn owl test --platform ios --update
```

--------------------------------

### Visual Regression Testing for iOS using GitHub Actions

Source: https://nearform.com/open-source/react-native-owl/docs/ci/github-actions

This workflow automates visual regression tests for the React Native Owl library on iOS. It checks out the code, sets up Node.js, installs dependencies including CocoaPods, caches Pods, configures an iOS simulator, builds the Owl library, runs tests, and uploads test artifacts on failure. Requires a macOS runner.

```yaml
name: Visual Regression - iOS  
  
on: [pull_request]  
  
jobs:
  run-visual-regression-ios:
    runs-on: macos-14  

    steps:
      - uses: actions/checkout@v4  

      - name: Get Runner Information  
        run: /usr/bin/xcodebuild -version  

      - name: Set up Node  
        uses: actions/setup-node@v4  
        with:  
          node-version: 20  
          cache: 'yarn'  

      - name: Install Dependencies  
        run: yarn install --frozen-lockfile  

      - name: Install CocoaPods  
        run: gem install cocoapods -v 1.11.0  

      - uses: actions/cache@v4  
        with:  
          path: ./ios/Pods  
          key: ${{ runner.os }}-pods-${{ hashFiles('**/Podfile.lock') }}  
          restore-keys: |
            ${{ runner.os }}-pods-  

      - name: Install CocoaPods  
        run: pod install  
        working-directory: ./ios  

      - uses: futureware-tech/simulator-action@v1  
        with:  
          model: 'iPhone 15 Pro'  
          os_version: '18.1'  

      - name: Run Owl Build  
        run: yarn owl:build:ios  

      - name: Run Owl Test  
        run: yarn owl:test:ios  

      - name: Store screenshots and report as artifacts  
        uses: actions/upload-artifact@v4  
        if: failure()  
        with:  
          name: owl-results  
          path: ./.owl  

```

--------------------------------

### Build React Native Owl App with npm

Source: https://nearform.com/open-source/react-native-owl/docs/cli/building-the-app

Builds the React Native Owl application using npm. Requires specifying the target platform and optionally a configuration file path. This command initiates the native build process for the specified platform.

```bash
npx owl build --platform ios --config ./owl.config.json
```

--------------------------------

### Build React Native Owl App with Yarn

Source: https://nearform.com/open-source/react-native-owl/docs/cli/building-the-app

Builds the React Native Owl application using Yarn. Requires specifying the target platform and optionally a configuration file path. This command initiates the native build process for the specified platform.

```bash
yarn owl build --platform ios --config ./owl.config.json
```

--------------------------------

### Run app tests with npm

Source: https://nearform.com/open-source/react-native-owl/docs/cli/testing-the-app

Executes the react-native-owl test command using npm to run tests on the iOS platform. This command compares current screenshots with baseline images.

```bash
npx owl test --platform ios
```

--------------------------------

### Use custom config file with npm

Source: https://nearform.com/open-source/react-native-owl/docs/cli/testing-the-app

Runs react-native-owl tests using npm, specifying a custom configuration file path with the `--config` option for the iOS platform.

```bash
npx owl test --platform ios --config ./owl.config.json
```

--------------------------------

### Use custom config file with Yarn

Source: https://nearform.com/open-source/react-native-owl/docs/cli/testing-the-app

Runs react-native-owl tests using Yarn, specifying a custom configuration file path with the `--config` option for the iOS platform.

```bash
yarn owl test --platform ios --config ./owl.config.json
```

--------------------------------

### Run app tests with Yarn

Source: https://nearform.com/open-source/react-native-owl/docs/cli/testing-the-app

Executes the react-native-owl test command using Yarn to run tests on the iOS platform. This command compares current screenshots with baseline images.

```bash
yarn owl test --platform ios
```

--------------------------------

### Update baseline images with npm

Source: https://nearform.com/open-source/react-native-owl/docs/cli/testing-the-app

Uses npm to run the react-native-owl test command with the `--update` flag, which regenerates the baseline images for the iOS platform.

```bash
npx owl test --platform ios --update
```

--------------------------------

### takeScreenshot

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Grabs a screenshot from the simulator and stores it under `latest` or `baseline` depending on the test run flags.

```APIDOC
## takeScreenshot(name: string)

### Description
Grabs a screenshot from the simulator and stores it under `latest` screenshots (e.g., `./owl/latest/ios/`) using the specified filename. If running tests with the `--update` or `-u` flag, or if it's the first time the test is run, the screenshot will be stored under the `baseline` directory.

### Method
`takeScreenshot`

### Parameters
#### Path Parameters
- **name** (string) - Required - The filename for the screenshot (extension is not required).

### Request Example
```typescript
import { takeScreenshot } from 'react-native-owl';

describe('App.tsx', () => {
  it('takes a screenshot of the first screen', async () => {
    const screen = await takeScreenshot('homescreen');
    expect(screen).toMatchBaseline();
  });
});
```

### Response
#### Success Response
Returns a promise that resolves with the screenshot data.

#### Response Example
(No specific response body is returned, the action is the side effect of saving a file.)

### Notes
- On the first test run or with `--update` flag, screenshots are stored at `./owl/baseline/ios/` or `./owl/baseline/android/`.
- On subsequent runs, screenshots are stored at `./owl/current/ios/` or `./owl/current/android/`.
```

--------------------------------

### Reload Application with React Native Owl

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Illustrates how to use the `reload` function from react-native-owl to terminate and restart the application. This is useful for ensuring a clean state before running test suites.

```typescript
import { reload } from 'react-native-owl';

describe('App.tsx', () => {
  describe('the checkout flow', () => {
    beforeAll(async () => {
      await reload();
    }),

    it('adds product to cart', async () => {
      ...
    });

    it('starts checkout flow', async () => {
      ...
    });
  });
});
```

--------------------------------

### Scroll and Screenshot with React Native Owl

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Demonstrates how to scroll a ScrollView component and then take a screenshot using react-native-owl. This is useful for verifying UI states after scrolling.

```typescript
import { scrollTo, takeScreenshot } from 'react-native-owl';

describe('App.tsx', () => {
  it('scroll down the screen a bit then takes a screenshot', async () => {
    await scrollTo('scrollView', {y: 50});

    const screen = await takeScreenshot('afterScrollTo');

    expect(screen).toMatchBaseline();
  });
});
```

--------------------------------

### press

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Simulates a press event on an element identified by its `testID`.

```APIDOC
## press(testID: string)

### Description
Calls the `onPress` prop callback of the element where its `testID` prop matches the provided `testID` argument. The method will retry for 10 seconds before throwing an error if the element is not found. The element must have an `onPress` prop, or an error will be thrown.

### Method
`press`

### Parameters
#### Path Parameters
- **testID** (string) - Required - The `testID` of the element to press.

### Request Example
```typescript
import { press, takeScreenshot } from 'react-native-owl';

describe('App.tsx', () => {
  it('presses a button with testID = `button` then takes a screenshot', async () => {
    await press('button');
    const screen = await takeScreenshot('afterButtonPress');
    expect(screen).toMatchBaseline();
  });
});
```

### Response
#### Success Response
Returns a promise that resolves after the `onPress` callback is triggered.

#### Response Example
(No specific response body is returned, the action is the side effect of the `onPress` callback execution.)

### Error Handling
- Throws an error if the element with the specified `testID` is not found within 10 seconds.
- Throws an error if the found element does not have an `onPress` prop.
```

--------------------------------

### Update baseline images with Yarn

Source: https://nearform.com/open-source/react-native-owl/docs/cli/testing-the-app

Uses Yarn to run the react-native-owl test command with the `--update` flag, which regenerates the baseline images for the iOS platform.

```bash
yarn owl test --platform ios --update
```

--------------------------------

### Take Screenshot with React Native Owl

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Captures a screenshot of the simulator and saves it. If run with --update or on the first run, it saves to 'baseline'; otherwise, it saves to 'latest'.

```typescript
import { takeScreenshot } from 'react-native-owl';  
  
describe('App.tsx', () => {  
  it('takes a screenshot of the first screen', async () => {  
    const screen = await takeScreenshot('homescreen');  
  
    expect(screen).toMatchBaseline();  
  });  
});  

```

--------------------------------

### toExist

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Waits for an element with a specific `testID` to exist in the component tree.

```APIDOC
## toExist(testID: string)

### Description
Waits for an element to exist in the component tree where its `testID` prop matches the provided `testID` argument. The method will retry for 10 seconds before throwing an error if the element is not found.

### Method
`toExist`

### Parameters
#### Path Parameters
- **testID** (string) - Required - The `testID` of the element to wait for.

### Request Example
```typescript
import { toExist, takeScreenshot } from 'react-native-owl';

describe('App.tsx', () => {
  it('waits for an element, then takes a screenshot', async () => {
    await toExist('testInput');
    const screen = await takeScreenshot('textInputExists');
    expect(screen).toMatchBaseline();
  });
});
```

### Response
#### Success Response
Returns a promise that resolves when the element is found.

#### Response Example
(No specific response body is returned, the action is the side effect of the element becoming available.)

### Error Handling
- Throws an error if the element with the specified `testID` is not found within 10 seconds.
```

--------------------------------

### reload

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Terminates and restarts the application in the emulator/simulator. Useful for resetting the app state between test suites.

```APIDOC
## reload

### Description
Terminates the app in the emulator/simulator, and restarts it. This is useful when you want to complete a set of tests and move onto a new set of tests. Depending on your use-case, you could call `reload` in a `beforeAll`, or `beforeEach` callback, or within a test case, to get the app into a clean state before each set of tests for example.

### Method
`reload()`

### Endpoint
N/A (This is a function call within the testing framework)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
import { reload } from 'react-native-owl';

describe('App.tsx', () => {
  describe('the checkout flow', () => {
    beforeAll(async () => {
      await reload();
    }),

    it('adds product to cart', async () => {
      // ...
    });

    it('starts checkout flow', async () => {
      // ...
    });
  });
});
```

### Response
#### Success Response (200)
N/A (This function performs an action, it does not return a value in the traditional sense, but it resolves when the app has been reloaded).

#### Response Example
None
```

--------------------------------

### Scroll to End and Screenshot with React Native Owl

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Shows how to scroll to the end of a ScrollView and capture a screenshot using react-native-owl. This is helpful for testing content that extends beyond the initial view.

```typescript
import { scrollToEnd, takeScreenshot } from 'react-native-owl';

describe('App.tsx', () => {
  it('scroll down the screen a bit then takes a screenshot', async () => {
    await scrollToEnd('scrollView');

    const screen = await takeScreenshot('afterScrollToEnd');

    expect(screen).toMatchBaseline();
  });
});
```

--------------------------------

### changeText

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Simulates text input change on an element identified by its `testID`.

```APIDOC
## changeText(testID: string, text: string)

### Description
Calls the `onChangeText` prop callback of the element where its `testID` prop matches the provided `testID` argument, passing the specified text. The method will retry for 10 seconds before throwing an error if the element is not found. The element must have an `onChangeText` prop, or an error will be thrown.

### Method
`changeText`

### Parameters
#### Path Parameters
- **testID** (string) - Required - The `testID` of the element to change text in.
- **text** (string) - Required - The text to input into the element.

### Request Example
```typescript
import { changeText, takeScreenshot } from 'react-native-owl';

describe('App.tsx', () => {
  it('changes text in a TextInput with testID = `email` then takes a screenshot', async () => {
    await changeText('email', 'john.smith@example.com');
    const screen = await takeScreenshot('afterChangeText');
    expect(screen).toMatchBaseline();
  });
});
```

### Response
#### Success Response
Returns a promise that resolves after the `onChangeText` callback is triggered.

#### Response Example
(No specific response body is returned, the action is the side effect of the `onChangeText` callback execution.)

### Error Handling
- Throws an error if the element with the specified `testID` is not found within 10 seconds.
- Throws an error if the found element does not have an `onChangeText` prop.
```

--------------------------------

### longPress

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Simulates a long press event on an element identified by its `testID`.

```APIDOC
## longPress(testID: string)

### Description
Calls the `onLongPress` prop callback of the element where its `testID` prop matches the provided `testID` argument. The method will retry for 10 seconds before throwing an error if the element is not found. The element must have an `onLongPress` prop, or an error will be thrown.

### Method
`longPress`

### Parameters
#### Path Parameters
- **testID** (string) - Required - The `testID` of the element to long press.

### Request Example
```typescript
import { longPress, takeScreenshot } from 'react-native-owl';

describe('App.tsx', () => {
  it('long presses a button with testID = `button` then takes a screenshot', async () => {
    await longPress('button');
    const screen = await takeScreenshot('afterButtonLongPress');
    expect(screen).toMatchBaseline();
  });
});
```

### Response
#### Success Response
Returns a promise that resolves after the `onLongPress` callback is triggered.

#### Response Example
(No specific response body is returned, the action is the side effect of the `onLongPress` callback execution.)

### Error Handling
- Throws an error if the element with the specified `testID` is not found within 10 seconds.
- Throws an error if the found element does not have an `onLongPress` prop.
```

--------------------------------

### Use toMatchBaseline Jest Matcher for Screenshot Comparison

Source: https://nearform.com/open-source/react-native-owl/docs/api/matchers

This custom Jest matcher compares a newly captured screenshot against a baseline image. It requires `takeScreenshot` to be called beforehand and accepts an optional `threshold` for pixel matching. The first run or runs with `--update` will always pass, establishing a new baseline.

```typescript
import { takeScreenshot } from 'react-native-owl';  
  
describe('App.tsx', () => {  
  it('takes a screenshot of the first screen', async () => {  
    const screen = await takeScreenshot('homescreen');  
  
    expect(screen).toMatchBaseline();  
  
    // Or with a custom threshold  
    expect(screen).toMatchBaseline({ threshold: 0.2 });  
  });  
});  

```

--------------------------------

### Simulate Button Press with React Native Owl

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Triggers the `onPress` prop of an element identified by its `testID`. It retries for 10 seconds and requires the element to have an `onPress` prop.

```typescript
import { press, takeScreenshot } from 'react-native-owl';  
  
describe('App.tsx', () => {  
  it('presses a button with testID = `button` then takes a screenshot', async () => {  
    await press('button');  
  
    const screen = await takeScreenshot('afterButtonPress');  
  
    expect(screen).toMatchBaseline();  
  });  
});  

```

--------------------------------

### scrollTo

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Calls the `scrollTo` method on a scrollable element identified by its `testID`.

```APIDOC
## scrollTo(testID: string, position: {x?: number, y?: number})

### Description
Calls the `scrollTo` method of the element where its `testID` prop matches the provided `testID` argument. The method will retry for 10 seconds before throwing an error if the element is not found. The element must have a `scrollTo` method (e.g., a `ScrollView`), or an error will be thrown.

### Method
`scrollTo`

### Parameters
#### Path Parameters
- **testID** (string) - Required - The `testID` of the scrollable element.
- **position** ({x?: number, y?: number}) - Optional - An object specifying the x and/or y coordinates to scroll to.

### Request Example
```typescript
// Assuming a ScrollView with testID='myScrollView'

import { scrollTo } from 'react-native-owl';

describe('ScrollView', () => {
  it('scrolls to a specific position', async () => {
    await scrollTo('myScrollView', { y: 500 });
    // Further assertions can be made here
  });
});
```

### Response
#### Success Response
Returns a promise that resolves when the `scrollTo` method is called.

#### Response Example
(No specific response body is returned, the action is the side effect of scrolling the element.)

### Error Handling
- Throws an error if the element with the specified `testID` is not found within 10 seconds.
- Throws an error if the found element does not have a `scrollTo` method.
```

--------------------------------

### Wait for Element Existence with React Native Owl

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Waits for an element with a specific testID to appear on the screen, retrying for 10 seconds. Throws an error if the element is not found within the timeout.

```typescript
import { toExist, takeScreenshot } from 'react-native-owl';  
  
describe('App.tsx', () => {  
  it('waits for an element, then takes a screenshot', async () => {  
    await toExist('testInput');  
  
    const screen = await takeScreenshot('textInputExists');  
  
    expect(screen).toMatchBaseline();  
  });  
});  

```

--------------------------------

### scrollToEnd

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Scrolls to the end of a scrollable component identified by its testID. Throws an error if the element is not found or does not have a scrollToEnd method.

```APIDOC
## scrollToEnd

### Description
Calls the `scrollToEnd` method of the element where its `testID` prop matches the methods `testID` argument. If there is no matching element, it will retry for 10 seconds before throwing an Error. The element must have a `scrollToEnd` method (i.e `ScrollView`), or an Error will be thrown.

### Method
`scrollToEnd(testID: string)`

### Endpoint
N/A (This is a function call within the testing framework)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// App.tsx
// ...
<ScrollView testID="scrollView">
  ...
</ScrollView>
// ...

// __tests__/App.owl.tsx
import { scrollToEnd, takeScreenshot } from 'react-native-owl';

describe('App.tsx', () => {
  it('scroll down the screen a bit then takes a screenshot', async () => {
    await scrollToEnd('scrollView');

    const screen = await takeScreenshot('afterScrollToEnd');

    expect(screen).toMatchBaseline();
  });
});
```

### Response
#### Success Response (200)
N/A (This function performs an action, it does not return a value in the traditional sense, but it resolves when the scroll action is complete).

#### Response Example
None
```

--------------------------------

### scrollTo

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Scrolls to a specific position within a scrollable component identified by its testID. It retries for 10 seconds if the element is not found.

```APIDOC
## scrollTo

### Description
Calls the `scrollTo` method of the element where its `testID` prop matches the methods `testID` argument. If there is no matching element, it will retry for 10 seconds before throwing an Error.

### Method
`scrollTo(testID: string, options: { y: number })`

### Endpoint
N/A (This is a function call within the testing framework)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// App.tsx
// ...
<ScrollView testID="scrollView">
  ...
</ScrollView>
// ...

// __tests__/App.owl.tsx
import { scrollTo, takeScreenshot } from 'react-native-owl';

describe('App.tsx', () => {
  it('scroll down the screen a bit then takes a screenshot', async () => {
    await scrollTo('scrollView', {y: 50});

    const screen = await takeScreenshot('afterScrollTo');

    expect(screen).toMatchBaseline();
  });
});
```

### Response
#### Success Response (200)
N/A (This function performs an action, it does not return a value in the traditional sense, but it resolves when the scroll action is complete).

#### Response Example
None
```

--------------------------------

### Simulate Long Press with React Native Owl

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Triggers the `onLongPress` prop of an element identified by its `testID`. It retries for 10 seconds and requires the element to have an `onLongPress` prop.

```typescript
import { longPress, takeScreenshot } from 'react-native-owl';  
  
describe('App.tsx', () => {  
  it('long presses a button with testID = `button` then takes a screenshot', async () => {  
    await longPress('button');  
  
    const screen = await takeScreenshot('afterButtonLongPress');  
  
    expect(screen).toMatchBaseline();  
  });  
});  

```

--------------------------------

### Scroll Element with React Native Owl

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Calls the `scrollTo` method on an element identified by its `testID`, optionally specifying x and y coordinates. It retries for 10 seconds and requires the element to have a `scrollTo` method, such as a ScrollView.

```typescript
/*
 * scrollTo(testID: string, position: {x?: number, y?: number})
 * Calls the `scrollTo` method of the element where its `testID` prop matches the methods `testID` argument.
 * If there is no matching element, it will retry for 10 seconds before throwing an Error.
 * The element must have a `scrollTo` method (i.e `ScrollView`), or an Error will be thrown.
 */

```

--------------------------------

### Change Text Input Value with React Native Owl

Source: https://nearform.com/open-source/react-native-owl/docs/api/methods

Calls the `onChangeText` prop of a TextInput element identified by its `testID` with the provided text. It retries for 10 seconds and requires the element to have an `onChangeText` prop.

```typescript
import { changeText, takeScreenshot } from 'react-native-owl';  
  
describe('App.tsx', () => {  
  it('changes text in a TextInput with testID = `email` then takes a screenshot', async () => {  
    await changeText('email', 'john.smith@example.com');  
  
    const screen = await takeScreenshot('afterChangeText');  
  
    expect(screen).toMatchBaseline();  
  });  
});  

```
Tokens:
Raw