Clipboard

Permission settings are required

getClipboardTextYou must set clipboard permissions before using it. Please check the permission setup guide first.

---

1. Get clipboard text

SDK function: getClipboardText

A function that reads the text stored in the clipboard.

Signature

function getClipboardText(): Promise<string>;

Return value

• Promise<string>

  Returns the text stored in the clipboard. If there is no text in the clipboard, returns an empty string.

Permission methods

• getClipboardText.getPermission

  Returns the current status of clipboard read permission. allowed · denied · notDetermined · osPermissionDenied returns one of
• getClipboardText.openPermissionDialog

  Shows a dialog to request clipboard read permission again. If allowed, allowed, if denied deniedis returned.

Error

If permission is denied GetClipboardTextPermissionErroroccurs. error instanceof GetClipboardTextPermissionErrorYou can check it with

class GetClipboardTextPermissionError extends PermissionError {
  constructor();
}

Example

Web (JS)

import { getClipboardText, GetClipboardTextPermissionError } from '@apps-in-toss/web-framework';

async function handleGetClipboardText() {
  try {
    const clipboardText = await getClipboardText();
    console.log('Clipboard text:', clipboardText || 'There is no text in the clipboard.');
  } catch (error) {
    if (error instanceof GetClipboardTextPermissionError) {
      console.log('No clipboard read permission');
    }
  }
}

Web (React)

import { getClipboardText, GetClipboardTextPermissionError } from '@apps-in-toss/web-framework';
import { useState } from 'react';

function PasteButton() {
  const [text, setText] = useState('');

  const handlePress = async () => {
    try {
      const clipboardText = await getClipboardText();
      setText(clipboardText || 'There is no text in the clipboard.');
    } catch (error) {
      if (error instanceof GetClipboardTextPermissionError) {
        // No clipboard read permission
      }
    }
  };

  return (
    <div>
      <span>{text}</span>
      <input type="button" value="Paste" onClick={handlePress} />
      <input
        type="button"
        value="Check permission"
        onClick={async () => {
          const permission = await getClipboardText.getPermission();
          alert(permission);
        }}
      />
      <input
        type="button"
        value="Request permission"
        onClick={async () => {
          const permission = await getClipboardText.openPermissionDialog();
          alert(permission);
        }}
      />

  );
}

React Native

import { getClipboardText, GetClipboardTextPermissionError } from '@apps-in-toss/framework';
import { useState } from 'react';
import { Alert, Button, Text, View } from 'react-native';

function PasteButton() {
  const [text, setText] = useState('');

  const handlePress = async () => {
    try {
      const clipboardText = await getClipboardText();
      setText(clipboardText || 'There is no text in the clipboard.');
    } catch (error) {
      if (error instanceof GetClipboardTextPermissionError) {
        // No clipboard read permission
      }
    }
  };

  return (
    <View>
      <Text>{text}</Text>
      <Button title="Paste" onPress={handlePress} />
      <Button
        title="Check Permission"
        onPress={async () => {
          const permission = await getClipboardText.getPermission();
          Alert.alert(permission);
        }}
      />
      <Button
        title="Request permission"
        onPress={async () => {
          const permission = await getClipboardText.openPermissionDialog();
          Alert.alert(permission);
        }}
      />
    </View>
  );
}

---

2. Copy clipboard text

SDK function: setClipboardText

A function that copies text to the clipboard. The user can paste it elsewhere.

Signature

function setClipboardText(text: string): Promise<void>;

Parameters

• text · Required · string

  The text to copy to the clipboard.

Permission methods

• setClipboardText.getPermission

  Returns the current status of clipboard write permission. allowed · denied · notDetermined · osPermissionDenied returns one of
• setClipboardText.openPermissionDialog

  Shows a dialog to request clipboard write permission again. If allowed, allowed, if denied deniedis returned.

Error

If permission is denied SetClipboardTextPermissionErroroccurs. error instanceof SetClipboardTextPermissionErrorYou can check it with

class SetClipboardTextPermissionError extends PermissionError {
  constructor();
}

Example

Web (JS)

import { setClipboardText, SetClipboardTextPermissionError } from '@apps-in-toss/web-framework';

async function handleSetClipboardText() {
  try {
    await setClipboardText('Text to copy');
    console.log('The text has been copied!');
  } catch (error) {
    if (error instanceof SetClipboardTextPermissionError) {
      console.log('No clipboard write permission');
    }
  }
}

Web (React)

import { setClipboardText, SetClipboardTextPermissionError } from '@apps-in-toss/web-framework';

function CopyButton() {
  const handleCopy = async () => {
    try {
      await setClipboardText('Text to copy');
      console.log('The text has been copied!');
    } catch (error) {
      if (error instanceof SetClipboardTextPermissionError) {
        // No clipboard write permission
      }
    }
  };

  return (
    <>
      <input type="button" value="Copy" onClick={handleCopy} />
      <input
        type="button"
        value="Check permission"
        onClick={async () => {
          const permission = await setClipboardText.getPermission();
          alert(permission);
        }}
      />
      <input
        type="button"
        value="Request permission"
        onClick={async () => {
          const permission = await setClipboardText.openPermissionDialog();
          alert(permission);
        }}
      />
    </>
  );
}

React Native

import { setClipboardText, SetClipboardTextPermissionError } from '@apps-in-toss/framework';
import { Alert, Button } from 'react-native';

function CopyButton() {
  const handleCopy = async () => {
    try {
      await setClipboardText('Text to copy');
      console.log('The text has been copied!');
    } catch (error) {
      if (error instanceof SetClipboardTextPermissionError) {
        // No clipboard write permission
      }
    }
  };

  return (
    <>
      <Button title="Copy" onPress={handleCopy} />
      <Button
        title="Check Permission"
        onPress={async () => {
          const permission = await setClipboardText.getPermission();
          Alert.alert(permission);
        }}
      />
      <Button
        title="Request permission"
        onPress={async () => {
          const permission = await setClipboardText.openPermissionDialog();
          Alert.alert(permission);
        }}
      />
    </>
  );
}