Skip to content

Commit

Permalink
Publish docs version 20.x
Browse files Browse the repository at this point in the history
  • Loading branch information
mobile1-internal committed Jan 11, 2024
1 parent bed7b96 commit 2032164
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
8 changes: 5 additions & 3 deletions website/versioned_docs/version-20.x/api/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,15 +144,17 @@ Continuously scrolls the scroll element until the specified expectation is resol
await waitFor(element(by.text('Text5'))).toBeVisible().whileElement(by.id('ScrollView630')).scroll(50, 'down');
```

### `scrollTo(edge)`
### `scrollTo(edge[, startPositionX, startPositionY])`

Simulates a scroll to the specified edge.

`edge`—the edge to scroll to (valid input: `"left"`/`"right"`/`"top"`/`"bottom"`)
`edge`—the edge to scroll to (valid input: `"left"`/`"right"`/`"top"`/`"bottom"`) <br/>
`startPositionX`—the normalized x percentage of the element to use as scroll start point (optional, valid input: \[0.0, 1.0], `NaN`—choose an optimal value automatically, default is `NaN`) <br/>
`startPositionY`—the normalized y percentage of the element to use as scroll start point (optional, valid input: \[0.0, 1.0], `NaN`—choose an optimal value automatically, default is `NaN`)

```js
await element(by.id('scrollView')).scrollTo('bottom');
await element(by.id('scrollView')).scrollTo('top');
await element(by.id('scrollView')).scrollTo('top', NaN, 0.2);
```

### `typeText(text)`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@ Please complete our [Introductory environment setup](introduction/environment-se

:::

## Node.js

We recommend using [`nvm`](https://github.com/nvm-sh/nvm) or [`nvm-windows`](https://github.com/coreybutler/nvm-windows) to manage your Node.js versions. However, you can find our required Node.js version in the [`.nvmrc`](https://github.com/wix/Detox/blob/master/.nvmrc) file and install it using your preferred method or from the [official download page](https://nodejs.org/en/download/).

Currently, we require `lts/iron` (Node.js 20.x) for our development environment.

:::tip

The exhaustive list of LTS codenames (e.g. `lts/iron`) can be found at [CODENAMES.md](https://github.com/nodejs/Release/blob/main/CODENAMES.md) in the Node.js repository.

:::

## Setting Up The Monorepo Management

Our repository is a monorepo, which means it contains multiple Detox-related projects and packages. [Read more about our repository structure](../code/overview.md#repository-structure).
Expand All @@ -17,7 +29,7 @@ To set up the monorepo locally, follow these steps:
Install the monorepo management tool, `lerna`:

```bash npm2yarn
npm install lerna@3.x.x --global
npm install lerna@6.x.x --global
```

Clone the repository and navigate to the project directory:
Expand Down

0 comments on commit 2032164

Please sign in to comment.