| Crates.io | tauri-plugin-screenshots |
| lib.rs | tauri-plugin-screenshots |
| version | 2.2.0 |
| created_at | 2025-02-27 14:39:48.917718+00 |
| updated_at | 2025-05-01 02:56:41.139991+00 |
| description | Get screenshots of windows and monitors. |
| homepage | |
| repository | https://github.com/ayangweb/tauri-plugin-screenshots |
| max_upload_size | |
| id | 1571793 |
| size | 233,542 |
This plugin only works on tauri v2, if you need the v1 plugin, feel free to submit a PR!
Get screenshots of windows and monitors.
https://github.com/user-attachments/assets/0cc6e2ea-cf85-41ed-a809-078393a95c0f
cargo add tauri-plugin-screenshots
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
pnpm add tauri-plugin-screenshots-api
src-tauri/src/lib.rs
pub fn run() {
tauri::Builder::default()
+ .plugin(tauri_plugin_screenshots::init())
.run(tauri::generate_context!())
.expect("error while running tauri application");
}
src-tauri/capabilities/default.json
{
...
"permissions": [
...
+ "screenshots:default"
]
}
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
import {
getScreenshotableWindows,
getWindowScreenshot,
} from "tauri-plugin-screenshots-api";
const windows = await getScreenshotableWindows();
const path = await getWindowScreenshot(windows[0].id);
console.log(path); // xx/tauri-plugin-screenshots/window-{id}.png
| Method | Description |
|---|---|
getScreenshotableWindows |
Get all windows that can take screenshots. |
getScreenshotableMonitors |
Get all monitors that can take screenshots. |
getWindowScreenshot |
Get a screenshot of the window with the specified id. |
getMonitorScreenshot |
Get a screenshot of the monitors with the specified id. |
removeWindowScreenshot |
Remove locally stored window screenshots. |
removeMonitorScreenshot |
Remove locally stored monitor screenshots. |
clearScreenshots |
Remove all locally stored screenshots. |
git clone https://github.com/ayangweb/tauri-plugin-screenshots.git
pnpm install
pnpm build
cd examples/tauri-app
pnpm install
pnpm tauri dev