Skip to content

Commit

Permalink
docs: add full URL information to README (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
Zardosh committed Apr 25, 2024
1 parent a41a8d3 commit 930da7d
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ Navigation happens when a user chooses a use case they want to try out.
By default, TestBox will use `window.location` to push the iFrame to a new URL.

If you use react-router, or any kind of client-side routing, you may want to override
our standard navigation behavior. To do so, especify your custom handler on the
configuration object for `startTestBox` method:
our standard navigation behavior. To do so, specify your custom handler in the
configuration object for the `startTestBox` method:

```javascript
const testboxConfig = {
Expand All @@ -65,6 +65,10 @@ startTestBox(testboxConfig);

```

Keep in mind that the URLs that come from TestBox are full URLs (e.g. `https://google.com/images`),
and not only the specific route (`/images`). You might have to manipulate the URL
to use it with a custom navigation behavior.

### Auto-login

If you have opted to use our client-side auto-login functionality, you have a bit
Expand Down

0 comments on commit 930da7d

Please sign in to comment.