7 releases (2 stable)

2.1.0 Feb 24, 2025
2.0.0 Oct 22, 2024
0.4.1 Feb 24, 2025
0.4.0 Jan 31, 2024
0.1.0 Nov 10, 2023

#348 in GUI

Download history 62/week @ 2024-11-16 70/week @ 2024-11-23 54/week @ 2024-11-30 124/week @ 2024-12-07 153/week @ 2024-12-14 155/week @ 2024-12-21 154/week @ 2024-12-28 196/week @ 2025-01-04 181/week @ 2025-01-11 184/week @ 2025-01-18 167/week @ 2025-01-25 239/week @ 2025-02-01 164/week @ 2025-02-08 247/week @ 2025-02-15 444/week @ 2025-02-22 305/week @ 2025-03-01

1,177 downloads per month
Used in 2 crates

Apache-2.0 OR MIT

49KB
909 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::HasWindowHandle 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 = tao::event_loop::EventLoop::new();
    let window = tao::window::WindowBuilder::new().build(&event_loop).unwrap();
    let webview = wry::WebViewBuilder::new().build(&window).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(),
    );
    
    • winit:
    let window = ...winit window;
    
    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.3–38MB
~563K SLoC