@tauri-apps/plugin-clipboard-manager 2.0.0-rc.2 → 2.0.1

package/README.md

@@ -2,9 +2,17 @@
 
 Read and write to the system clipboard.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
-_This plugin requires a Rust version of at least **1.75**_
+_This plugin requires a Rust version of at least **1.77.2**_
 
 There are three general methods of installation that we can recommend.
 
@@ -18,7 +26,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
 
 ```toml
 [dependencies]
-tauri-plugin-clipboard-manager = "2.0.0-rc"
+tauri-plugin-clipboard-manager = "2.0.0"
 # alternatively with Git:
 tauri-plugin-clipboard-manager = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
 ```

package/dist-js/index.cjs

@@ -44,6 +44,11 @@ async function readText() {
 }
 /**
  * Writes image buffer to the clipboard.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { writeImage } from '@tauri-apps/plugin-clipboard-manager';
@@ -67,12 +72,17 @@ async function writeImage(image$1) {
 }
 /**
  * Gets the clipboard content as Uint8Array image.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { readImage } from '@tauri-apps/plugin-clipboard-manager';
  *
  * const clipboardImage = await readImage();
- * const blob = new Blob([clipboardImage.bytes], { type: 'image' })
+ * const blob = new Blob([await clipboardImage.rbga()], { type: 'image' })
  * const url = URL.createObjectURL(blob)
  * ```
  * @since 2.0.0
@@ -82,6 +92,11 @@ async function readImage() {
 }
 /**
  * * Writes HTML or fallbacks to write provided plain text to the clipboard.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';
@@ -94,10 +109,10 @@ async function readImage() {
  *
  * @since 2.0.0
  */
-async function writeHtml(html, altHtml) {
+async function writeHtml(html, altText) {
     await core.invoke('plugin:clipboard-manager|write_html', {
         html,
-        altHtml
+        altText
     });
 }
 /**

package/dist-js/index.d.ts

@@ -27,6 +27,11 @@ declare function writeText(text: string, opts?: {
 declare function readText(): Promise<string>;
 /**
  * Writes image buffer to the clipboard.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { writeImage } from '@tauri-apps/plugin-clipboard-manager';
@@ -46,12 +51,17 @@ declare function readText(): Promise<string>;
 declare function writeImage(image: string | Image | Uint8Array | ArrayBuffer | number[]): Promise<void>;
 /**
  * Gets the clipboard content as Uint8Array image.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { readImage } from '@tauri-apps/plugin-clipboard-manager';
  *
  * const clipboardImage = await readImage();
- * const blob = new Blob([clipboardImage.bytes], { type: 'image' })
+ * const blob = new Blob([await clipboardImage.rbga()], { type: 'image' })
  * const url = URL.createObjectURL(blob)
  * ```
  * @since 2.0.0
@@ -59,6 +69,11 @@ declare function writeImage(image: string | Image | Uint8Array | ArrayBuffer | n
 declare function readImage(): Promise<Image>;
 /**
  * * Writes HTML or fallbacks to write provided plain text to the clipboard.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';
@@ -71,7 +86,7 @@ declare function readImage(): Promise<Image>;
  *
  * @since 2.0.0
  */
-declare function writeHtml(html: string, altHtml?: string): Promise<void>;
+declare function writeHtml(html: string, altText?: string): Promise<void>;
 /**
  * Clears the clipboard.
  *

package/dist-js/index.js

@@ -42,6 +42,11 @@ async function readText() {
 }
 /**
  * Writes image buffer to the clipboard.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { writeImage } from '@tauri-apps/plugin-clipboard-manager';
@@ -65,12 +70,17 @@ async function writeImage(image) {
 }
 /**
  * Gets the clipboard content as Uint8Array image.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { readImage } from '@tauri-apps/plugin-clipboard-manager';
  *
  * const clipboardImage = await readImage();
- * const blob = new Blob([clipboardImage.bytes], { type: 'image' })
+ * const blob = new Blob([await clipboardImage.rbga()], { type: 'image' })
  * const url = URL.createObjectURL(blob)
  * ```
  * @since 2.0.0
@@ -80,6 +90,11 @@ async function readImage() {
 }
 /**
  * * Writes HTML or fallbacks to write provided plain text to the clipboard.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';
@@ -92,10 +107,10 @@ async function readImage() {
  *
  * @since 2.0.0
  */
-async function writeHtml(html, altHtml) {
+async function writeHtml(html, altText) {
     await invoke('plugin:clipboard-manager|write_html', {
         html,
-        altHtml
+        altText
     });
 }
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tauri-apps/plugin-clipboard-manager",
-  "version": "2.0.0-rc.2",
-  "license": "MIT or APACHE-2.0",
+  "version": "2.0.1",
+  "license": "MIT OR Apache-2.0",
   "authors": [
     "Tauri Programme within The Commons Conservancy"
   ],
@@ -24,6 +24,6 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@tauri-apps/api": "^2.0.0-rc.4"
+    "@tauri-apps/api": "^2.0.0"
   }
 }