firefox-webdriver 0.1.4

High-performance Firefox WebDriver in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# Examples

Index of example files in the `examples/` directory.

## Running Examples

```bash
cargo run --example 001_basic_launch
cargo run --example 001_basic_launch -- --no-wait  # Auto-close after run
cargo run --example 001_basic_launch -- --debug    # Enable debug logging
cargo run --example 001_basic_launch -- --clean    # Clean profile (001 only)
```

## Example Index

| File                         | Complexity | Description                                          |
| ---------------------------- | :--------: | ---------------------------------------------------- |
| `001_basic_launch.rs`        |     ⭐     | Driver setup, window spawning, profile management    |
| `002_navigation.rs`          |     ⭐     | Navigate, back, forward, reload, get URL/title       |
| `003_script_execution.rs`    |     ⭐     | Sync/async JavaScript execution                      |
| `004_element_query.rs`       |    ⭐⭐    | Find elements with By strategies, nested search      |
| `005_element_interaction.rs` |    ⭐⭐    | Click, type, focus, blur, isTrusted events           |
| `006_storage.rs`             |    ⭐⭐    | Cookies, localStorage, sessionStorage                |
| `007_frame_switching.rs`     |   ⭐⭐⭐   | iframe navigation, frame hierarchy                   |
| `008_element_observer.rs`    |   ⭐⭐⭐   | MutationObserver, wait_for_element, callbacks        |
| `009_proxy.rs`               |   ⭐⭐⭐   | HTTP/SOCKS5 proxy, per-tab/window configuration      |
| `010_network_intercept.rs`   |  ⭐⭐⭐⭐  | Block rules, request/response interception           |
| `011_canvas_fingerprint.rs`  |  ⭐⭐⭐⭐  | Canvas randomization verification                    |
| `012_multi_window.rs`        |   ⭐⭐⭐   | Multiple windows, parallel automation                |
| `013_screenshot.rs`          |    ⭐⭐    | Page and element screenshots, PNG/JPEG               |
| `014_forms.rs`               |    ⭐⭐    | Checkboxes, radio buttons, dropdowns                 |
| `015_keyboard.rs`            |    ⭐⭐    | Keyboard input, special keys, modifiers              |
| `016_mouse.rs`               |    ⭐⭐    | Mouse actions, double-click, hover, drag             |

## Shared Utilities

All examples use `common.rs` which provides:

- `Args` - Command-line argument parsing (`--debug`, `--no-wait`, `--clean`)
- `init_logging()` - Tracing/logging initialization
- `wait_for_exit()` - Graceful Ctrl+C handling
- `print_logs()` - Extension log output
- `FIREFOX_BINARY` / `EXTENSION_PATH` - Default paths

## Quick Start Example

```rust
use firefox_webdriver::{Driver, By, Result};

#[tokio::main]
async fn main() -> Result<()> {
    let driver = Driver::builder()
        .binary("./bin/firefox")
        .extension("firefox-webdriver-extension-0.1.3.xpi")
        .build().await?;

    let window = driver.window()
        .window_size(1280, 720)
        .spawn()
        .await?;

    let tab = window.tab();
    tab.goto("https://example.com").await?;

    // Find element using By strategies
    let heading = tab.find_element(By::Tag("h1")).await?;
    println!("Heading: {}", heading.get_text().await?);

    // Screenshot
    tab.save_screenshot("example.png").await?;

    driver.close().await?;
    Ok(())
}
```

## See Also

- [Getting Started](../getting-started.md) - Quick start guide
- [API Documentation](../api/) - API reference
- [Guides](../guides/) - How-to guides