From 17cfb8a23bb99ff6c815131b1772de71271ea0a8 Mon Sep 17 00:00:00 2001
From: Maccesch <maccesch@synphonyte.com>
Date: Fri, 26 Jul 2024 10:56:39 +0100
Subject: [PATCH] clarified read option docs for use_clipboard.

Closes #119
---
 .idea/leptos-use.iml               | 1 +
 examples/use_clipboard/src/main.rs | 6 ++++--
 src/use_clipboard.rs               | 2 ++
 3 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml
index 7d56fcb..b65a8a2 100644
--- a/.idea/leptos-use.iml
+++ b/.idea/leptos-use.iml
@@ -77,6 +77,7 @@
       <sourceFolder url="file://$MODULE_DIR$/examples/use_or/src" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/examples/use_event_source/src" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/examples/sync_signal/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/examples/use_user_media/src" isTestSource="false" />
       <excludeFolder url="file://$MODULE_DIR$/examples/use_event_listener/target" />
       <excludeFolder url="file://$MODULE_DIR$/target" />
       <excludeFolder url="file://$MODULE_DIR$/docs/book/book" />
diff --git a/examples/use_clipboard/src/main.rs b/examples/use_clipboard/src/main.rs
index e7852b3..ebfbf63 100644
--- a/examples/use_clipboard/src/main.rs
+++ b/examples/use_clipboard/src/main.rs
@@ -1,6 +1,8 @@
 use leptos::*;
 use leptos_use::docs::{demo_or_body, Note};
-use leptos_use::{use_clipboard, use_permission, UseClipboardReturn};
+use leptos_use::{
+    use_clipboard_with_options, use_permission, UseClipboardOptions, UseClipboardReturn,
+};
 
 #[component]
 fn Demo() -> impl IntoView {
@@ -11,7 +13,7 @@ fn Demo() -> impl IntoView {
         text,
         copied,
         copy,
-    } = use_clipboard();
+    } = use_clipboard_with_options(UseClipboardOptions::default().read(true));
 
     let permission_read = use_permission("clipboard-read");
     let permission_write = use_permission("clipboard-write");
diff --git a/src/use_clipboard.rs b/src/use_clipboard.rs
index 78c7eb9..2d4ab26 100644
--- a/src/use_clipboard.rs
+++ b/src/use_clipboard.rs
@@ -127,6 +127,8 @@ pub fn use_clipboard_with_options(
 pub struct UseClipboardOptions {
     /// When `true` event handlers are added so that the returned signal `text` is updated whenever the clipboard changes.
     /// Defaults to `false`.
+    /// 
+    /// > Please note that clipboard changes are only detected when copying or cutting text inside the same document.
     read: bool,
 
     /// After how many milliseconds after copying should the returned signal `copied` be set to `false`?