Struct Builder

pub struct Builder { /* private fields */ }

Implementations

impl Builder

pub fn new() -> Self

Create a new builder with default values.

pub fn with_flags(self, flags: Flags) -> Self

Set flags to control which shortcuts the plugin should disable.

Examples

use tauri_plugin_prevent_default::Flags;

tauri_plugin_prevent_default::Builder::new()
  .with_flags(Flags::CONTEXT_MENU | Flags::PRINT | Flags::DOWNLOADS)
  .build();

pub fn shortcut<S>(self, shortcut: S) -> Self

where S: Shortcut + 'static,

Disable a custom shortcut.

Examples

use tauri_plugin_prevent_default::KeyboardShortcut;
use tauri_plugin_prevent_default::ModifierKey::{CtrlKey, ShiftKey};

tauri_plugin_prevent_default::Builder::new()
  .shortcut(KeyboardShortcut::new("F12"))
  .shortcut(KeyboardShortcut::with_modifiers("E", &[CtrlKey, ShiftKey]))
  .shortcut(KeyboardShortcut::with_shift_alt("I"))
  .build();

pub fn check_origin(self, origin: impl AsRef<str>) -> Self

Check location origin before disabling the shortcuts.

pub fn build<R: Runtime>(self) -> TauriPlugin<R>

Build the plugin.

pub fn build_with_manual_injection<R: Runtime>(self) -> TauriPlugin<R>

Build the plugin, but do not inject the script into the webviews. The script should then be manually set as the initialization script when creating the window.

Examples

use tauri::{AppHandle, WebviewUrl, WebviewWindowBuilder};
use tauri_plugin_prevent_default::PreventDefault;

fn create_window(app: &AppHandle) {
  let url = WebviewUrl::App("index.html".into());
  WebviewWindowBuilder::new(app, "main", url)
    .initialization_script(app.script())
    .build()
    .unwrap();
}

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.