@tauri-apps/plugin-clipboard-manager 2.0.0-beta.0 → 2.0.0-beta.2

package/README.md

@@ -4,7 +4,7 @@ Read and write to the system clipboard.
 
 ## Install
 
-_This plugin requires a Rust version of at least **1.70**_
+_This plugin requires a Rust version of at least **1.75**_
 
 There are three general methods of installation that we can recommend.
 
@@ -60,7 +60,7 @@ fn main() {
 Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
 
 ```javascript
-import { writeText, readText } from "@tauri-apps/plugin-clipboard-manager";
+import { writeText, readText, writeHtml, readHtml, clear } from "@tauri-apps/plugin-clipboard-manager";
 await writeText("Tauri is awesome!");
 assert(await readText(), "Tauri is awesome!");
 ```

package/dist-js/index.cjs

@@ -46,6 +46,45 @@ async function readText() {
     const kind = await core.invoke("plugin:clipboard-manager|read");
     return kind.plainText.text;
 }
+/**
+ * Writes HTML or fallbacks to write provided plain text to the clipboard.
+ * @example
+ * ```typescript
+ * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeHtml('<h1>Tauri is awesome!</h1>', 'plaintext');
+ * await writeHtml('<h1>Tauri is awesome!</h1>', '<h1>Tauri is awesome</h1>'); // Will write "<h1>Tauri is awesome</h1>" as plain text
+ * assert(await readText(), '<h1>Tauri is awesome!</h1>');
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function writeHtml(html, altHtml) {
+    return core.invoke("plugin:clipboard-manager|write_html", {
+        data: {
+            html: {
+                html,
+                altHtml,
+            },
+        },
+    });
+}
+/**
+ * Clears the clipboard.
+ * @example
+ * ```typescript
+ * import { clear } from '@tauri-apps/plugin-clipboard-manager';
+ * await clear();
+ * ```
+ * @since 2.0.0
+ */
+async function clear() {
+    await core.invoke("plugin:clipboard-manager|clear");
+    return;
+}
 
+exports.clear = clear;
 exports.readText = readText;
+exports.writeHtml = writeHtml;
 exports.writeText = writeText;

package/dist-js/index.d.ts

@@ -24,4 +24,29 @@ declare function writeText(text: string, opts?: {
  * @since 2.0.0
  */
 declare function readText(): Promise<string>;
-export { writeText, readText };
+/**
+ * Writes HTML or fallbacks to write provided plain text to the clipboard.
+ * @example
+ * ```typescript
+ * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeHtml('<h1>Tauri is awesome!</h1>', 'plaintext');
+ * await writeHtml('<h1>Tauri is awesome!</h1>', '<h1>Tauri is awesome</h1>'); // Will write "<h1>Tauri is awesome</h1>" as plain text
+ * assert(await readText(), '<h1>Tauri is awesome!</h1>');
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+declare function writeHtml(html: string, altHtml?: string): Promise<void>;
+/**
+ * Clears the clipboard.
+ * @example
+ * ```typescript
+ * import { clear } from '@tauri-apps/plugin-clipboard-manager';
+ * await clear();
+ * ```
+ * @since 2.0.0
+ */
+declare function clear(): Promise<void>;
+export { writeText, readText, writeHtml, clear };

package/dist-js/index.js

@@ -44,5 +44,42 @@ async function readText() {
     const kind = await invoke("plugin:clipboard-manager|read");
     return kind.plainText.text;
 }
+/**
+ * Writes HTML or fallbacks to write provided plain text to the clipboard.
+ * @example
+ * ```typescript
+ * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeHtml('<h1>Tauri is awesome!</h1>', 'plaintext');
+ * await writeHtml('<h1>Tauri is awesome!</h1>', '<h1>Tauri is awesome</h1>'); // Will write "<h1>Tauri is awesome</h1>" as plain text
+ * assert(await readText(), '<h1>Tauri is awesome!</h1>');
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function writeHtml(html, altHtml) {
+    return invoke("plugin:clipboard-manager|write_html", {
+        data: {
+            html: {
+                html,
+                altHtml,
+            },
+        },
+    });
+}
+/**
+ * Clears the clipboard.
+ * @example
+ * ```typescript
+ * import { clear } from '@tauri-apps/plugin-clipboard-manager';
+ * await clear();
+ * ```
+ * @since 2.0.0
+ */
+async function clear() {
+    await invoke("plugin:clipboard-manager|clear");
+    return;
+}
 
-export { readText, writeText };
+export { clear, readText, writeHtml, writeText };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tauri-apps/plugin-clipboard-manager",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.2",
   "license": "MIT or APACHE-2.0",
   "authors": [
     "Tauri Programme within The Commons Conservancy"
@@ -20,7 +20,7 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@tauri-apps/api": "2.0.0-beta.0"
+    "@tauri-apps/api": "2.0.0-beta.4"
   },
   "scripts": {
     "build": "rollup -c"