@react-native-clipboard/clipboard

React Native Clipboard API for macOS, iOS, Android, and Windows.

macOS	iOS	Android	Windows

Getting started

Install the library using either Yarn:

yarn add @react-native-clipboard/clipboard

or npm:

npm install --save @react-native-clipboard/clipboard

Link

React Native v0.60+

For iOS, use cocoapods to link the package.

run the following command:

$ npx pod-install

For android, the package will be linked automatically on build.

$ react-native link @react-native-clipboard/clipboard

cd ios && pod install && cd ..

$ react-native unlink @react-native-clipboard/clipboard

Migrating from the core react-native module

This module was created when the Clipboard API was split out from the core of React Native. To migrate to this module you need to follow the installation instructions above and then change you imports from:

1import {Clipboard} from 'react-native';

to:

1import Clipboard from '@react-native-clipboard/clipboard';

Example

1import React, {useState} from 'react';
2import {
3  SafeAreaView,
4  View,
5  Text,
6  TouchableOpacity,
7  StyleSheet,
8} from 'react-native';
9import Clipboard from '@react-native-clipboard/clipboard';
10
11const App = () => {
12  const [copiedText, setCopiedText] = useState('');
13
14  const copyToClipboard = () => {
15    Clipboard.setString('hello world');
16  };
17
18  const fetchCopiedText = async () => {
19    const text = await Clipboard.getString();
20    setCopiedText(text);
21  };
22
23  return (
24    <SafeAreaView style={{flex: 1}}>
25      <View style={styles.container}>
26        <TouchableOpacity onPress={copyToClipboard}>
27          <Text>Click here to copy to Clipboard</Text>
28        </TouchableOpacity>
29        <TouchableOpacity onPress={fetchCopiedText}>
30          <Text>View copied text</Text>
31        </TouchableOpacity>
32
33        <Text style={styles.copiedText}>{copiedText}</Text>
34      </View>
35    </SafeAreaView>
36  );
37};
38
39const styles = StyleSheet.create({
40  container: {
41    flex: 1,
42    justifyContent: 'center',
43    alignItems: 'center',
44  },
45  copiedText: {
46    marginTop: 10,
47    color: 'red',
48  },
49});
50
51export default App;

Reference

Methods

Clipboard

getString()

1static getString()

Get content of string type, this method returns a Promise, so you can use following code to get clipboard content

1async _getContent() {
2  var content = await Clipboard.getString();
3}

getStrings()

1static getStrings()

(iOS only) Get contents of string array type, this method returns a Promise, so you can use following code to get clipboard content

1async _getContent() {
2  var content = await Clipboard.getStrings();
3}

setString()

1static setString(content)

Set content of string type. You can use following code to set clipboard content

1_setContent() {
2  Clipboard.setString('hello world');
3}

Parameters

setStrings()

1static setStrings(content)

(iOS only) Set content of string array type. You can use following code to set clipboard content

1_setContent() {
2  Clipboard.setStrings(['hello world', 'second string']);
3}

Parameters

hasString()

1static hasString()

Returns whether the clipboard has content or is empty. Can check if there is a content in clipboard without triggering PasteBoard notification for iOS 14+

hasURL()

1static hasURL()

(iOS only) Returns whether the clipboard has a URL content. Can check if there is a URL content in clipboard without triggering PasteBoard notification for iOS 14+

hasNumber()

1static hasNumber()

(iOS 14+ only) Returns whether the clipboard has a Number(UIPasteboardDetectionPatternNumber) content. Can check if there is a Number content in clipboard without triggering PasteBoard notification for iOS 14+

hasWebURL()

1static hasWebURL()

(iOS 14+ only) Returns whether the clipboard has a WebURL(UIPasteboardDetectionPatternProbableWebURL) content. Can check if there is a WebURL content in clipboard without triggering PasteBoard notification for iOS 14+

useClipboard

useClipboard is a utility hooks for the Clipboard module. data contains the content stored in the clipboard.

1import React, {useEffect} from 'react';
2import {Text} from 'react-native';
3import {useClipboard} from '@react-native-clipboard/clipboard';
4
5export const HooksSample = () => {
6  const [data, setString] = useClipboard();
7
8  useEffect(() => {
9    setString('hello world');
10  }, []);
11
12  return <Text>{data}</Text>;
13};

getImage()

1static getImage()

Get content of image in base64 string type, this method returns a Promise, so you can use following code to get clipboard content (iOS and Android Only)

1async _getContent() {
2  var content = await Clipboard.getImage();
3}

Mocking Clipboard

If you're using jest as a test runner, you will need to setup a mock for clipboard, as NativeModules will be undefined when testing with Jest.

Create a jest.setup.js in your project root,and set up the following to have Clipboard mocked:

1import mockClipboard from '@react-native-clipboard/clipboard/jest/clipboard-mock.js';
2
3jest.mock('@react-native-clipboard/clipboard', () => mockClipboard);

Maintainers

• M.Haris Baig
• Jesse Katsumata

Contributing

Please see the contributing guide.

License

The library is released under the MIT licence. For more information see LICENSE.