Skip to content

docs: add SPA tab-isolation guidance #1203

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.

Sign up for GitHub

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

Open
hiSandog wants to merge 1 commit into
base: main
Choose a base branch
from
+49 −0
Open

docs: add SPA tab-isolation guidance #1203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,33 @@ agent-browser tab close [n] # Close tab
agent-browser window new # New window
```

### SPA Detail Pages

On SPAs with dynamic result lists, refs from `snapshot` often become stale if
you click into a detail page and then navigate back. A more reliable pattern is
to keep the source tab on the list page and open detail pages in a temporary
tab:

```bash
# 1. Snapshot the result list
agent-browser snapshot -i -c

# 2. Open one result in a new tab instead of leaving the list page
agent-browser click @e12 --new-tab
agent-browser tab 1

# 3. Inspect the detail page, then close it
agent-browser snapshot -i -c
agent-browser tab close

# 4. Return to the source tab and re-snapshot before the next item
agent-browser tab 0
agent-browser snapshot -i -c
```

This avoids invalidating refs on the source page and is especially useful for
search results, infinite-scroll feeds, and modal-heavy applications.

### Frames

```bash
Expand Down
22 changes: 22 additions & 0 deletions docs/src/app/snapshots/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,28 @@ agent-browser snapshot -i # Get fresh refs
agent-browser click @e1 # Use new refs
```

On dynamic SPAs, `back()` can also trigger a full re-render of the source list,
which means previously captured refs may no longer point at the same items. In
those flows, keep the source tab stable and open detail pages in a temporary
tab:

```bash
agent-browser snapshot -i -c
agent-browser click @e12 --new-tab
agent-browser tab 1

# Inspect the detail page
agent-browser snapshot -i -c

# Close it and return to the original list
agent-browser tab close
agent-browser tab 0
agent-browser snapshot -i -c
```

This pattern is more reliable for result feeds, search pages, and other UIs
that reassign refs whenever the list re-renders.

## Annotated screenshots

For visual context alongside text snapshots, use `screenshot --annotate` to overlay numbered labels on interactive elements. Each label `[N]` maps to ref `@eN`:
Expand Down