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
use std::rc::Rc;
use gloo::file::Blob as GlooBlob;
use js_sys::{Array, ArrayBuffer, Object, Reflect, Uint8Array};
use wasm_bindgen::UnwrapThrowExt;
use wasm_bindgen::{prelude::*, JsCast, JsValue};
use web_sys::Blob;
use yew::prelude::*;
use super::{use_state_ptr_eq, UseStatePtrEqHandle};
use crate::web_sys_ext::{window, ClipboardItem};
/// State handle for the [`use_clipboard`] hook.
pub struct UseClipboardHandle {
/// The text that is read from or written to clipboard.
pub text: UseStatePtrEqHandle<Option<String>>,
/// The bytes that is read from or written to clipboard.
pub bytes: UseStatePtrEqHandle<Option<Vec<u8>>>,
/// The mime type of the bytes that is read from or written to clipboard.
pub bytes_mime_type: UseStatePtrEqHandle<Option<String>>,
/// If the content is already copied.
pub copied: UseStatePtrEqHandle<bool>,
/// If the clipboard is supported.
pub is_supported: Rc<bool>,
write_text: Rc<dyn Fn(String)>,
write: Rc<dyn Fn(Vec<u8>, Option<String>)>,
read_text: Rc<dyn Fn()>,
read: Rc<dyn Fn()>,
}
impl UseClipboardHandle {
/// Read bytes from clipboard.
pub fn read(&self) {
(self.read)();
}
/// Read text from clipboard.
pub fn read_text(&self) {
(self.read_text)();
}
/// Write bytes with mime type to clipboard.
pub fn write(&self, data: Vec<u8>, mime_type: Option<String>) {
(self.write)(data, mime_type);
}
/// Write text to clipboard.
pub fn write_text(&self, data: String) {
(self.write_text)(data);
}
}
impl Clone for UseClipboardHandle {
fn clone(&self) -> Self {
Self {
text: self.text.clone(),
bytes: self.bytes.clone(),
bytes_mime_type: self.bytes_mime_type.clone(),
is_supported: self.is_supported.clone(),
copied: self.copied.clone(),
write_text: self.write_text.clone(),
write: self.write.clone(),
read_text: self.read_text.clone(),
read: self.read.clone(),
}
}
}
/// This hook is used to read from or write to clipboard for text or bytes.
/// e.g. copy plain text or copy `image/png` file to clipboard.
///
/// # Example
///
/// ```rust
/// # use yew::prelude::*;
/// #
/// use yew_hooks::prelude::*;
///
/// #[function_component(UseClipboard)]
/// fn clipboard() -> Html {
/// let clipboard = use_clipboard();
///
/// let onclick_write_text = {
/// let clipboard = clipboard.clone();
/// Callback::from(move |_| {
/// clipboard.write_text("hello world!".to_owned());
/// })
/// };
/// let onclick_read_text = {
/// let clipboard = clipboard.clone();
/// Callback::from(move |_| {
/// clipboard.read_text();
/// })
/// };
/// let onclick_write_bytes = {
/// let clipboard = clipboard.clone();
/// Callback::from(move |_| {
/// clipboard.write(vec![], Some("image/png".to_owned()));
/// })
/// };
/// let onclick_read_bytes = {
/// let clipboard = clipboard.clone();
/// Callback::from(move |_| {
/// clipboard.read();
/// })
/// };
///
/// html! {
/// <div>
/// <button onclick={onclick_write_text}>{ "Write text to clipboard" }</button>
/// <button onclick={onclick_read_text}>{ "Read text from clipboard" }</button>
/// <button onclick={onclick_write_bytes}>{ "Write bytes to clipboard" }</button>
/// <button onclick={onclick_read_bytes}>{ "Read bytes from clipboard" }</button>
/// <p>{ format!("Current text: {:?}", *clipboard.text) }</p>
/// <p>{ format!("Copied: {:?}", *clipboard.copied) }</p>
/// <p>{ format!("Is supported: {:?}", *clipboard.is_supported) }</p>
/// <p>{ format!("Current bytes: {:?}", *clipboard.bytes) }</p>
/// <p>{ format!("Current bytes mime type: {:?}", *clipboard.bytes_mime_type) }</p>
/// </div>
/// }
/// }
/// ```
#[hook]
pub fn use_clipboard() -> UseClipboardHandle {
let text = use_state_ptr_eq(|| None);
let bytes = use_state_ptr_eq(|| None);
let bytes_mime_type = use_state_ptr_eq(|| None);
let is_supported = use_memo(
|_| {
window()
.expect_throw("Can't find the global Window")
.navigator()
.clipboard()
.is_some()
},
(),
);
let copied = use_state_ptr_eq(|| false);
let clipboard = use_memo(
|_| {
window()
.expect_throw("Can't find the global Window")
.navigator()
.clipboard()
},
(),
);
let write_text = {
let clipboard = clipboard.clone();
let text = text.clone();
let copied = copied.clone();
Rc::new(move |data: String| {
if let Some(clipboard) = &*clipboard {
let text = text.clone();
let text2 = text.clone();
let copied = copied.clone();
let copied2 = copied.clone();
let data2 = data.clone();
let resolve_closure = Closure::wrap(Box::new(move |_| {
text.set(Some(data.clone()));
copied.set(true);
}) as Box<dyn FnMut(JsValue)>);
let reject_closure = Closure::wrap(Box::new(move |_| {
text2.set(None);
copied2.set(false);
}) as Box<dyn FnMut(JsValue)>);
let _ = clipboard
.write_text(&data2)
.then2(&resolve_closure, &reject_closure);
resolve_closure.forget();
reject_closure.forget();
}
})
};
let write = {
let clipboard = clipboard.clone();
let bytes = bytes.clone();
let bytes_mime_type = bytes_mime_type.clone();
let copied = copied.clone();
Rc::new(move |data: Vec<u8>, mime_type: Option<String>| {
if let Some(clipboard) = &*clipboard {
let blob = GlooBlob::new_with_options(&*data, mime_type.as_deref());
let object = Object::new();
if Reflect::set(
&object,
&JsValue::from(mime_type.as_deref()),
&JsValue::from(blob),
)
.is_ok()
{
if let Ok(item) = ClipboardItem::new(&object) {
let items = Array::new();
items.push(&item);
let bytes = bytes.clone();
let bytes2 = bytes.clone();
let bytes_mime_type = bytes_mime_type.clone();
let bytes_mime_type2 = bytes_mime_type.clone();
let copied = copied.clone();
let copied2 = copied.clone();
let resolve_closure = Closure::wrap(Box::new(move |_| {
bytes.set(Some(data.clone()));
bytes_mime_type.set(mime_type.clone());
copied.set(true);
})
as Box<dyn FnMut(JsValue)>);
let reject_closure = Closure::wrap(Box::new(move |_| {
bytes2.set(None);
bytes_mime_type2.set(None);
copied2.set(false);
})
as Box<dyn FnMut(JsValue)>);
let _ = clipboard
.write(&items)
.then2(&resolve_closure, &reject_closure);
resolve_closure.forget();
reject_closure.forget();
}
}
}
})
};
let read_text = {
let clipboard = clipboard.clone();
let text = text.clone();
Rc::new(move || {
if let Some(clipboard) = &*clipboard {
let text = text.clone();
let text2 = text.clone();
let resolve_closure = Closure::wrap(Box::new(move |data: JsValue| {
data.as_string().map_or_else(
|| {
text.set(None);
},
|data| {
if data.is_empty() {
text.set(None);
} else {
text.set(Some(data));
}
},
);
}) as Box<dyn FnMut(JsValue)>);
let reject_closure = Closure::wrap(Box::new(move |_| {
text2.set(None);
}) as Box<dyn FnMut(JsValue)>);
let _ = clipboard
.read_text()
.then2(&resolve_closure, &reject_closure);
resolve_closure.forget();
reject_closure.forget();
}
})
};
let read = {
let bytes = bytes.clone();
let bytes_mime_type = bytes_mime_type.clone();
Rc::new(move || {
if let Some(clipboard) = &*clipboard {
let bytes = bytes.clone();
let bytes2 = bytes.clone();
let bytes_mime_type = bytes_mime_type.clone();
let bytes_mime_type2 = bytes_mime_type.clone();
let resolve_closure = Closure::wrap(Box::new(move |items| {
let items = Array::from(&items);
let bytes = bytes.clone();
for item in items.iter() {
item.dyn_into::<ClipboardItem>().map_or_else(
|_| {
bytes.set(None);
bytes_mime_type.set(None);
},
|item| {
for t in item.types().iter() {
t.as_string().map_or_else(
|| {
bytes.set(None);
bytes_mime_type.set(None);
},
|t| {
let bytes = bytes.clone();
let bytes2 = bytes.clone();
let bytes_mime_type = bytes_mime_type.clone();
let bytes_mime_type2 = bytes_mime_type.clone();
let t2 = t.clone();
let resolve_closure =
Closure::wrap(Box::new(move |blob: JsValue| {
blob.dyn_into::<Blob>().map_or_else(
|_| {
bytes.set(None);
bytes_mime_type.set(None);
},
|blob| {
let bytes = bytes.clone();
let bytes2 = bytes.clone();
let bytes_mime_type =
bytes_mime_type.clone();
let bytes_mime_type2 =
bytes_mime_type.clone();
let t = t.clone();
let resolve_closure = Closure::wrap(
Box::new(move |buffer: JsValue| {
buffer
.dyn_into::<ArrayBuffer>()
.map_or_else(
|_| {
bytes.set(None);
bytes_mime_type.set(None);
},
|buffer| {
let data = Uint8Array::new(
&buffer,
)
.to_vec();
bytes.set(Some(data));
bytes_mime_type
.set(Some(t.clone()));
},
);
})
as Box<dyn FnMut(JsValue)>,
);
let reject_closure =
Closure::wrap(Box::new(move |_| {
bytes2.set(None);
bytes_mime_type2.set(None);
})
as Box<dyn FnMut(JsValue)>);
let _ = blob.array_buffer().then2(
&resolve_closure,
&reject_closure,
);
resolve_closure.forget();
reject_closure.forget();
},
);
})
as Box<dyn FnMut(JsValue)>);
let reject_closure = Closure::wrap(Box::new(move |_| {
bytes2.set(None);
bytes_mime_type2.set(None);
})
as Box<dyn FnMut(JsValue)>);
let _ = item
.get_type(&t2)
.then2(&resolve_closure, &reject_closure);
resolve_closure.forget();
reject_closure.forget();
},
);
}
},
);
}
}) as Box<dyn FnMut(JsValue)>);
let reject_closure = Closure::wrap(Box::new(move |_| {
bytes2.set(None);
bytes_mime_type2.set(None);
}) as Box<dyn FnMut(JsValue)>);
let _ = clipboard.read().then2(&resolve_closure, &reject_closure);
resolve_closure.forget();
reject_closure.forget();
}
})
};
UseClipboardHandle {
text,
bytes,
bytes_mime_type,
copied,
is_supported,
write_text,
write,
read_text,
read,
}
}