ui.clipboard becomes class

Author: evnchn

nicegui/functions/clipboard.py

@@ -12,65 +12,69 @@
     pass
 
 
-async def read() -> Optional[str]:
-    """Read text from the clipboard.
+class Clipboard:
+    """Wrapper for clipboard helper functions."""
 
-    Note: This function only works in secure contexts (HTTPS or localhost).
-    """
-    result = await run_javascript('''
-        if (navigator.clipboard) {
-            return navigator.clipboard.readText()
-        }
-        else {
-            console.error('Clipboard API is only available in secure contexts (HTTPS or localhost).')
-        }
-    ''')
-    if result is None:
-        log.warning('Clipboard API is only available in secure contexts (HTTPS or localhost).')
-    return result
+    async def read(self) -> Optional[str]:
+        """Read text from the clipboard.
 
+        Note: This function only works in secure contexts (HTTPS or localhost).
+        """
+        result = await run_javascript('''
+            if (navigator.clipboard) {
+                return navigator.clipboard.readText()
+            }
+            else {
+                console.error('Clipboard API is only available in secure contexts (HTTPS or localhost).')
+            }
+        ''')
+        if result is None:
+            log.warning('Clipboard API is only available in secure contexts (HTTPS or localhost).')
+        return result
 
-def write(text: str) -> None:
-    """Write text to the clipboard.
-
-    Note: This function only works in secure contexts (HTTPS or localhost).
+    def write(self, text: str) -> None:
+        """Write text to the clipboard.
 
-    :param text: text to write
-    """
-    run_javascript(f'''
-        if (navigator.clipboard) {{
-            navigator.clipboard.writeText({json.dumps(text)})
-        }}
-        else {{
-            console.error('Clipboard API is only available in secure contexts (HTTPS or localhost).')
-        }}
-    ''')
+        Note: This function only works in secure contexts (HTTPS or localhost).
 
+        :param text: text to write
+        """
+        run_javascript(f'''
+            if (navigator.clipboard) {{
+                navigator.clipboard.writeText({json.dumps(text)})
+            }}
+            else {{
+                console.error('Clipboard API is only available in secure contexts (HTTPS or localhost).')
+            }}
+        ''')
 
-async def read_image() -> Union['PIL_Image.Image', None]:
-    """Read PIL images from the clipboard.
+    async def read_image(self) -> Union['PIL_Image.Image', None]:
+        """Read PIL images from the clipboard.
 
-    Note: This function only works in secure contexts (HTTPS or localhost) and requires Pillow to be installed.
+        Note: This function only works in secure contexts (HTTPS or localhost) and requires Pillow to be installed.
 
-    *Added in version 2.10.0*
-    """
-    if not optional_features.has('pillow'):
-        log.warning('Pillow is not installed, so we cannot read images from the clipboard.')
-        return None
-    content = await run_javascript('''
-        if (navigator.clipboard) {
-            const items = await navigator.clipboard.read();
-            for (const item of items) {
-                if (item.types.length > 0 && /^image/.test(item.types[0])) {
-                    return await item.getType(item.types[0]);
+        *Added in version 2.10.0*
+        """
+        if not optional_features.has('pillow'):
+            log.warning('Pillow is not installed, so we cannot read images from the clipboard.')
+            return None
+        content = await run_javascript('''
+            if (navigator.clipboard) {
+                const items = await navigator.clipboard.read();
+                for (const item of items) {
+                    if (item.types.length > 0 && /^image/.test(item.types[0])) {
+                        return await item.getType(item.types[0]);
+                    }
                 }
             }
-        }
-        else {
-            console.error('Clipboard API is only available in secure contexts (HTTPS or localhost).');
-        }
-    ''', timeout=5)
-    if not content:
-        return None
-    buffer = io.BytesIO(content)
-    return PIL_Image.open(buffer)
+            else {
+                console.error('Clipboard API is only available in secure contexts (HTTPS or localhost).');
+            }
+        ''', timeout=5)
+        if not content:
+            return None
+        buffer = io.BytesIO(content)
+        return PIL_Image.open(buffer)
+
+
+clipboard = Clipboard()

nicegui/ui.py

@@ -264,7 +264,7 @@
 from nicegui.elements.upload import Upload as upload
 from nicegui.elements.video import Video as video
 from nicegui.elements.xterm import Xterm as xterm
-from nicegui.functions import clipboard
+from nicegui.functions.clipboard import clipboard
 from nicegui.functions.download import download
 from nicegui.functions.html import add_body_html, add_head_html
 from nicegui.functions.javascript import run_javascript
@@ -402,7 +402,7 @@
     from .elements.upload import Upload as upload
     from .elements.video import Video as video
     from .elements.xterm import Xterm as xterm
-    from .functions import clipboard
+    from .functions.clipboard import clipboard
     from .functions.download import download
     from .functions.html import add_body_html, add_head_html
     from .functions.javascript import run_javascript