Clipboard

The Clipboard API reads and writes the system clipboard.

Try it online

Hello, Mini-SDK

Copy to clipboardRead clipboard

Quick copy

GreetingJSONURL

Clipboard API demo

Use `setClipboard` to write and `getClipboard` to read. Try the shortcuts and watch the SDK toast in the corner.

Vue

<script setup>
import { ref } from 'vue'
import woo from 'mini-sdk'

const text = ref('要复制的文本')
const readText = ref('')

async function copy() {
  await woo.setClipboard({ text: text.value })
  woo.showToast({ title: '已复制', icon: 'success' })
}

async function paste() {
  const res = await woo.getClipboard()
  readText.value = res.text
}
</script>

<template>
  <input v-model="text" />
  <button @click="copy">复制</button>
  <button @click="paste">粘贴</button>
  <p>{{ readText }}</p>
</template>

React

import { useState } from 'react'
import woo from 'mini-sdk'

function ClipboardDemo() {
  const [text, setText] = useState('要复制的文本')
  const [readText, setReadText] = useState('')

  async function copy() {
    await woo.setClipboard({ text })
    woo.showToast({ title: '已复制', icon: 'success' })
  }

  async function paste() {
    const res = await woo.getClipboard()
    setReadText(res.text)
  }

  return (
    <>
      <input value={text} onChange={(e) => setText(e.target.value)} />
      <button onClick={copy}>复制</button>
      <button onClick={paste}>粘贴</button>
      <p>{readText}</p>
    </>
  )
}

Import

import woo from 'mini-sdk'
// 或
import { clipboard } from 'mini-sdk'

API reference

setClipboard

Writes text to the clipboard.

woo.setClipboard(options: { text: string }): Promise<void>

await woo.setClipboard({ text: '复制的内容' })
woo.showToast('已复制到剪贴板')

getClipboard

Reads the clipboard.

woo.getClipboard(): Promise<{ text: string }>

const { text } = await woo.getClipboard()
console.log('剪贴板内容：', text)

End-to-end example

Vue

<script setup>
import woo from 'mini-sdk'

async function copyShareLink(id) {
  const link = `https://app.example.com/share/${id}`
  await woo.setClipboard({ text: link })
  woo.showToast({ title: '链接已复制', icon: 'success' })
}

async function pasteAndSearch() {
  try {
    const { text } = await woo.getClipboard()
    if (text) await performSearch(text)
  } catch {
    woo.showToast({ title: '无法读取剪贴板', icon: 'none' })
  }
}
</script>

React

import woo from 'mini-sdk'

function ShareButton({ id }: { id: string }) {
  async function copyShareLink() {
    const link = `https://app.example.com/share/${id}`
    await woo.setClipboard({ text: link })
    woo.showToast({ title: '链接已复制', icon: 'success' })
  }

  async function pasteAndSearch() {
    try {
      const { text } = await woo.getClipboard()
      if (text) await performSearch(text)
    } catch {
      woo.showToast({ title: '无法读取剪贴板', icon: 'none' })
    }
  }

  return <button onClick={copyShareLink}>复制链接</button>
}

API quick reference

Method	Description	Signature
setClipboardData	Set clipboard content	({ data }) → Promise<void>
getClipboardData	Get clipboard content	() → Promise<{ data }>