4 releases (breaking)

0.4.0 Jan 31, 2024
0.3.0 Dec 18, 2023
0.2.0 Dec 7, 2023
0.1.0 Nov 10, 2023

#453 in GUI

Download history 10/week @ 2023-12-18 9/week @ 2023-12-25 77/week @ 2024-01-01 113/week @ 2024-01-08 138/week @ 2024-01-15 171/week @ 2024-01-22 14/week @ 2024-01-29 31/week @ 2024-02-19 55/week @ 2024-02-26 24/week @ 2024-03-04 18/week @ 2024-03-11 18/week @ 2024-03-18 44/week @ 2024-03-25 179/week @ 2024-04-01

261 downloads per month
Used in 2 crates

Apache-2.0 OR MIT

43KB
854 lines

Start a drag operation out of a window on macOS, Windows and Linux (via GTK).

Tested for tao (latest), winit (latest), wry (v0.24) and tauri (v1) windows.

Due to the GTK-based implementation, winit currently cannot leverage this crate on Linux yet.

  • Add the drag dependency:

$ cargo add drag

  • Use the drag::start_drag function. It takes a &T: raw_window_handle::HasRawWindowHandle type on macOS and Windows, and a &gtk::ApplicationWindow on Linux:

  • tao:

    let event_loop = tao::event_loop::EventLoop::new();
    let window = tao::window::WindowBuilder::new().build(&event_loop).unwrap();
    
    let item = drag::DragItem::Files(vec![std::fs::canonicalize("./examples/icon.png").unwrap()]);
    let preview_icon = drag::Image::File("./examples/icon.png".into());
    
    drag::start_drag(
      #[cfg(target_os = "linux")]
      {
        use tao::platform::unix::WindowExtUnix;
        window.gtk_window()
      },
      #[cfg(not(target_os = "linux"))]
      &window,
      item,
      preview_icon,
      |result, cursor_position| {
        println!("drag result: {result:?}");
      },
      drag::Options::default(),
    );
    
    • wry:
    let event_loop = wry::application::event_loop::EventLoop::new();
    let window = wry::application::window::WindowBuilder::new().build(&event_loop).unwrap();
    let webview = wry::webview::WebViewBuilder::new(window).unwrap().build().unwrap();
    
    let item = drag::DragItem::Files(vec![std::fs::canonicalize("./examples/icon.png").unwrap()]);
    let preview_icon = drag::Image::File("./examples/icon.png".into());
    
    drag::start_drag(
      #[cfg(target_os = "linux")]
      {
        use wry::application::platform::unix::WindowExtUnix;
        webview.window().gtk_window()
      },
      #[cfg(not(target_os = "linux"))]
      &webview.window(),
      item,
      preview_icon,
      |result, cursor_position| {
        println!("drag result: {result:?}");
      },
      drag::Options::default(),
    );
    
    • winit:
    let event_loop = winit::event_loop::EventLoop::new().unwrap();
    let window = winit::window::WindowBuilder::new().build(&event_loop).unwrap();
    
    let item = drag::DragItem::Files(vec![std::fs::canonicalize("./examples/icon.png").unwrap()]);
    let preview_icon = drag::Image::File("./examples/icon.png".into());
    
    let _ = drag::start_drag(&window, item, preview_icon, |result, cursor_position| {
      println!("drag result: {result:?}");
    }, Default::default());
    

Dependencies

~0.4–47MB
~672K SLoC