html_view 0.2.2

A Rust library for rendering HTML content in a native tauri application.
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
use html_view_shared::{BehaviourOptions, EnvironmentOptions, ViewerContent, WindowOptions};

/// Options for configuring a viewer instance.
///
/// This struct provides full control over how the viewer window behaves, what content
/// it displays, and how it interacts with the user.
///
/// # Examples
///
/// Creating options for different content types:
///
/// ```
/// use html_view::ViewerOptions;
/// use std::path::PathBuf;
///
/// // Inline HTML
/// let opts1 = ViewerOptions::inline_html("<h1>Hello</h1>");
///
/// // Local file
/// let opts2 = ViewerOptions::local_file(PathBuf::from("index.html"));
///
/// // Application directory
/// let opts3 = ViewerOptions::app_dir(PathBuf::from("./dist"));
/// ```
///
/// Customizing options:
///
/// ```
/// use html_view::ViewerOptions;
///
/// let mut opts = ViewerOptions::inline_html("<h1>Custom</h1>");
/// opts.window.width = Some(800);
/// opts.window.height = Some(600);
/// opts.window.title = Some("My App".to_string());
/// opts.behaviour.enable_devtools = true;
/// opts.environment.timeout_seconds = Some(30);
/// ```
#[derive(Debug, Clone)]
pub struct ViewerOptions {
    /// The content to display.
    ///
    /// See [`ViewerContent`] for all supported content types.
    pub content: ViewerContent,

    /// Window configuration.
    ///
    /// Controls size, position, decorations, and visual appearance.
    pub window: WindowOptions,

    /// Behaviour and security options.
    ///
    /// Controls navigation, remote content, devtools, and notifications.
    pub behaviour: BehaviourOptions,

    /// Environment options.
    ///
    /// Controls working directory and timeout behavior.
    pub environment: EnvironmentOptions,

    /// Dialog configuration.
    ///
    /// Controls whether file and message dialogs are allowed.
    pub dialog: html_view_shared::DialogOptions,

    /// Whether to wait for the viewer to close.
    ///
    /// In [`ViewerWaitMode::Blocking`] mode, the call blocks until the window closes.
    /// In [`ViewerWaitMode::NonBlocking`] mode, returns immediately with a handle.
    pub wait: ViewerWaitMode,
}

/// Determines whether the viewer call blocks or returns immediately.
///
/// # Examples
///
/// Blocking mode (default):
///
/// ```no_run
/// use html_view::{ViewerOptions, ViewerWaitMode};
///
/// let opts = ViewerOptions::inline_html("<h1>Hello</h1>");
/// assert_eq!(opts.wait, ViewerWaitMode::Blocking);
///
/// // This call will block until the window is closed
/// html_view::open(opts).unwrap();
/// ```
///
/// Non-blocking mode:
///
/// ```no_run
/// use html_view::{ViewerOptions, ViewerWaitMode, ViewerResult};
///
/// let mut opts = ViewerOptions::inline_html("<h1>Hello</h1>");
/// opts.wait = ViewerWaitMode::NonBlocking;
///
/// match html_view::open(opts).unwrap() {
///     ViewerResult::NonBlocking(handle) => {
///         // Returns immediately, window is open in background
///         println!("Window opened with ID: {}", handle.id);
///     }
///     _ => unreachable!(),
/// }
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ViewerWaitMode {
    /// Block until the viewer exits and return the exit status.
    ///
    /// This is the default mode and suitable for most use cases.
    /// The function call will not return until the user closes the window
    /// or a timeout is reached.
    Blocking,

    /// Return immediately with a handle to the running viewer process.
    ///
    /// Use this mode when you need to:
    /// - Continue working while the viewer is open
    /// - Manage multiple viewers simultaneously
    /// - Poll for window status
    /// - Terminate the viewer programmatically
    NonBlocking,
}

impl ViewerOptions {
    /// Create options for displaying inline HTML with default settings.
    ///
    /// This uses secure defaults:
    /// - Window size: 1024x768
    /// - Resizable: true
    /// - External navigation: disabled
    /// - Devtools: disabled
    /// - Remote content: disabled
    /// - Wait mode: Blocking
    ///
    /// # Example
    ///
    /// ```
    /// use html_view::ViewerOptions;
    ///
    /// let options = ViewerOptions::inline_html("<h1>Hello!</h1>");
    /// ```
    pub fn inline_html<S: Into<String>>(html: S) -> Self {
        Self {
            content: ViewerContent::InlineHtml {
                html: html.into(),
                base_dir: None,
            },
            window: WindowOptions::default(),
            behaviour: BehaviourOptions::default(),
            environment: EnvironmentOptions::default(),
            dialog: html_view_shared::DialogOptions::default(),
            wait: ViewerWaitMode::Blocking,
        }
    }

    /// Create options for displaying a local HTML file.
    ///
    /// # Example
    ///
    /// ```
    /// use html_view::ViewerOptions;
    /// use std::path::PathBuf;
    ///
    /// let options = ViewerOptions::local_file(PathBuf::from("index.html"));
    /// ```
    pub fn local_file(path: std::path::PathBuf) -> Self {
        Self {
            content: ViewerContent::LocalFile { path },
            window: WindowOptions::default(),
            behaviour: BehaviourOptions::default(),
            environment: EnvironmentOptions::default(),
            dialog: html_view_shared::DialogOptions::default(),
            wait: ViewerWaitMode::Blocking,
        }
    }

    /// Create options for displaying an HTML application directory.
    ///
    /// # Example
    ///
    /// ```
    /// use html_view::ViewerOptions;
    /// use std::path::PathBuf;
    ///
    /// let options = ViewerOptions::app_dir(PathBuf::from("./dist"));
    /// ```
    pub fn app_dir(root: std::path::PathBuf) -> Self {
        Self {
            content: ViewerContent::AppDir { root, entry: None },
            window: WindowOptions::default(),
            behaviour: BehaviourOptions::default(),
            environment: EnvironmentOptions::default(),
            dialog: html_view_shared::DialogOptions::default(),
            wait: ViewerWaitMode::Blocking,
        }
    }

    /// Create options for displaying a remote URL.
    ///
    /// Note: This automatically enables `allow_remote_content` in the behaviour options.
    ///
    /// # Example
    ///
    /// ```
    /// use html_view::ViewerOptions;
    /// use url::Url;
    ///
    /// let url = Url::parse("https://example.com").unwrap();
    /// let options = ViewerOptions::remote_url(url);
    /// ```
    pub fn remote_url(url: url::Url) -> Self {
        Self {
            content: ViewerContent::RemoteUrl { url },
            window: WindowOptions::default(),
            behaviour: BehaviourOptions {
                allow_remote_content: true,
                ..Default::default()
            },
            environment: EnvironmentOptions::default(),
            dialog: html_view_shared::DialogOptions::default(),
            wait: ViewerWaitMode::Blocking,
        }
    }
    /// Create a new builder for ViewerOptions.
    #[allow(clippy::new_ret_no_self)]
    pub fn new() -> ViewerOptionsBuilder {
        ViewerOptionsBuilder::default()
    }
}

/// Builder for constructing ViewerOptions.
#[derive(Default)]
pub struct ViewerOptionsBuilder {
    options: ViewerOptions,
}

impl ViewerOptionsBuilder {
    /// Set the content to display (Inline HTML).
    pub fn content(mut self, content: ViewerContent) -> Self {
        self.options.content = content;
        self
    }

    /// Set the window title.
    pub fn title<S: Into<String>>(mut self, title: S) -> Self {
        self.options.window.title = Some(title.into());
        self
    }

    /// Set the window size.
    pub fn size(mut self, width: u32, height: u32) -> Self {
        self.options.window.width = Some(width);
        self.options.window.height = Some(height);
        self
    }

    /// Set window position.
    pub fn position(mut self, x: i32, y: i32) -> Self {
        self.options.window.x = Some(x);
        self.options.window.y = Some(y);
        self
    }

    /// Set window width only.
    pub fn width(mut self, width: u32) -> Self {
        self.options.window.width = Some(width);
        self
    }

    /// Set window height only.
    pub fn height(mut self, height: u32) -> Self {
        self.options.window.height = Some(height);
        self
    }

    /// Set X position only.
    pub fn x(mut self, x: i32) -> Self {
        self.options.window.x = Some(x);
        self
    }

    /// Set Y position only.
    pub fn y(mut self, y: i32) -> Self {
        self.options.window.y = Some(y);
        self
    }

    /// Disable window decorations (frameless window).
    pub fn no_decorations(mut self) -> Self {
        self.options.window.decorations = false;
        self
    }

    /// Make the window transparent.
    pub fn transparent(mut self) -> Self {
        self.options.window.transparent = true;
        self
    }

    /// Keep window always on top.
    pub fn always_on_top(mut self) -> Self {
        self.options.window.always_on_top = true;
        self
    }

    /// Enable devtools.
    pub fn devtools(mut self) -> Self {
        self.options.behaviour.enable_devtools = true;
        self
    }

    /// Allow external navigation.
    pub fn allow_navigation(mut self) -> Self {
        self.options.behaviour.allow_external_navigation = true;
        self
    }

    /// Set timeout in seconds.
    pub fn timeout(mut self, seconds: u64) -> Self {
        self.options.environment.timeout_seconds = Some(seconds);
        self
    }

    /// Set working directory for resolving relative paths.
    pub fn working_dir(mut self, dir: std::path::PathBuf) -> Self {
        self.options.environment.working_dir = Some(dir);
        self
    }

    /// Allow remote content loading.
    pub fn allow_remote_content(mut self) -> Self {
        self.options.behaviour.allow_remote_content = true;
        self
    }

    /// Set allowed navigation domains (automatically enables allow_external_navigation).
    pub fn allowed_domains(mut self, domains: Vec<String>) -> Self {
        self.options.behaviour.allowed_domains = Some(domains);
        self.options.behaviour.allow_external_navigation = true;
        self
    }

    /// Make window non-resizable.
    pub fn fixed_size(mut self) -> Self {
        self.options.window.resizable = false;
        self
    }

    /// Set non-blocking mode (returns immediately with a handle).
    pub fn non_blocking(mut self) -> Self {
        self.options.wait = ViewerWaitMode::NonBlocking;
        self
    }

    /// Set window theme.
    pub fn theme(mut self, theme: html_view_shared::WindowTheme) -> Self {
        self.options.window.theme_enum = Some(theme);
        self
    }

    /// Enable system notifications.
    pub fn enable_notifications(mut self) -> Self {
        self.options.behaviour.allow_notifications = true;
        self
    }

    /// Enable file and message dialogs.
    pub fn enable_dialogs(mut self) -> Self {
        self.options.dialog.allow_file_dialogs = true;
        self.options.dialog.allow_message_dialogs = true;
        self
    }

    /// Configure the custom toolbar.
    pub fn toolbar(mut self, toolbar: html_view_shared::ToolbarOptions) -> Self {
        self.options.window.toolbar = toolbar;
        self
    }

    /// Open the viewer with the configured options.
    ///
    /// This requires content to be set. If content is not set, it defaults to empty HTML.
    pub fn show(self) -> Result<crate::ViewerResult, crate::ViewerError> {
        crate::open(self.options)
    }

    /// Open the viewer with inline HTML content.
    pub fn show_html<S: Into<String>>(
        mut self,
        html: S,
    ) -> Result<crate::ViewerResult, crate::ViewerError> {
        self.options.content = ViewerContent::InlineHtml {
            html: html.into(),
            base_dir: None,
        };
        crate::open(self.options)
    }

    /// Open the viewer with a local file.
    pub fn show_file(
        mut self,
        path: std::path::PathBuf,
    ) -> Result<crate::ViewerResult, crate::ViewerError> {
        self.options.content = ViewerContent::LocalFile { path };
        crate::open(self.options)
    }

    /// Open the viewer with an app directory.
    pub fn show_app_dir(
        mut self,
        root: std::path::PathBuf,
        entry: Option<String>,
    ) -> Result<crate::ViewerResult, crate::ViewerError> {
        self.options.content = ViewerContent::AppDir { root, entry };
        crate::open(self.options)
    }

    /// Open the viewer with a remote URL (automatically enables allow_remote_content).
    pub fn show_url(mut self, url: url::Url) -> Result<crate::ViewerResult, crate::ViewerError> {
        self.options.content = ViewerContent::RemoteUrl { url };
        self.options.behaviour.allow_remote_content = true;
        crate::open(self.options)
    }

    /// Set base directory for inline HTML (for resolving relative asset paths).
    pub fn base_dir(mut self, dir: std::path::PathBuf) -> Self {
        if let ViewerContent::InlineHtml { html, .. } = &self.options.content {
            self.options.content = ViewerContent::InlineHtml {
                html: html.clone(),
                base_dir: Some(dir),
            };
        }
        self
    }
}

impl Default for ViewerOptions {
    fn default() -> Self {
        Self {
            content: ViewerContent::InlineHtml {
                html: String::new(),
                base_dir: None,
            },
            window: WindowOptions::default(),
            behaviour: BehaviourOptions::default(),
            environment: EnvironmentOptions::default(),
            dialog: html_view_shared::DialogOptions::default(),
            wait: ViewerWaitMode::Blocking,
        }
    }
}