Skip to content

update docs to show exclude and filter #105

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

Merged
merged 3 commits into from
Jul 11, 2025
Merged

update docs to show exclude and filter #105

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b7d93b
fix: missing `width` and `height` in types
tarwin Jul 10, 2025
950d5c3
Merge branch 'zumerlab:main' into main
tarwin Jul 10, 2025
550a5ad
chore: update docs to show `exclude` and `filter`
tarwin Jul 10, 2025
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,8 @@ All capture methods accept an `options` object:
| `quality` | number | `1` | Quality for JPG/WebP (0 to 1) |
| `useProxy` | string | '' | Specify a proxy for handling CORS images as fallback|
| `type` | string | `svg` | Select `png`, `jpg`, `webp` Blob type|
| `exclude` | string[] | - | CSS selectors for elements to exclude |
| `filter` | function | - | Custom filter function ie `(el) => !el.classList.contains('hidden')` |

### Setting custom dimensions with width and height options

Expand Down