@react-native-community/clipboard

[![Build Status][build-badge]][build]
[![Version][version-badge]][package]
![Supports macOS, iOS, Android, and Windows][support-badge]
[![MIT License][license-badge]][license]
[![Lean Core Badge][lean-core-badge]][lean-core-issue]

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-community/clipboard
`

or npm:

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

Link

$3

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.

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:

`javascript
import {Clipboard} from 'react-native';
`

to:

`javascript
import Clipboard from '@react-native-community/clipboard';
`

Example

`jsx
import React, {useState} from 'react';
import {
SafeAreaView,
View,
Text,
TouchableOpacity,
StyleSheet,
} from 'react-native';
import Clipboard from '@react-native-community/clipboard';

const App = () => {
const [copiedText, setCopiedText] = useState('');

const copyToClipboard = () => {
Clipboard.setString('hello world');
};

const fetchCopiedText = async () => {
const text = await Clipboard.getString();
setCopiedText(text);
};

return (



Click here to copy to Clipboard


View copied text


{copiedText}


);
};

const styles = StyleSheet.create({
container: {
flex: 1,
justifyContent: 'center',
alignItems: 'center',
},
copiedText: {
marginTop: 10,
color: 'red',
},
});

export default App;
`

Reference

Methods

$3

#### getString()

`jsx
static getString()
`

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

`jsx
async _getContent() {
var content = await Clipboard.getString();
}
`

---

#### setString()

`jsx
static setString(content)
`

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

`jsx
_setContent() {
Clipboard.setString('hello world');
}
`

#### Parameters

| Name | Type | Required | Description |
| ------- | ------ | -------- | ----------------------------------------- |
| content | string | Yes | The content to be stored in the clipboard |

#### hasString()

`jsx
static 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()

`jsx
static 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+

$3

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

`jsx
import React, {useEffect} from 'react';
import {Text} from 'react-native';
import {useClipboard} from '@react-native-community/clipboard';

export const HooksSample = () => {
const [data, setString] = useClipboard();

useEffect(() => {
setString('hello world');
}, []);

return {data};
};
`

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`.

[build-badge]: https://github.com/react-native-community/clipboard/workflows/Build/badge.svg
[build]: https://github.com/react-native-community/clipboard/actions
[version-badge]: https://img.shields.io/npm/v/@react-native-community/clipboard.svg?style=flat-square
[package]: https://www.npmjs.com/package/@react-native-community/clipboard
[support-badge]: https://img.shields.io/badge/platforms-android%20|%20ios%20|%20macos%20|%20windows-lightgrey.svg?style=flat-square
[license-badge]: https://img.shields.io/npm/l/@react-native-community/clipboard.svg?style=flat-square
[license]: https://opensource.org/licenses/MIT
[lean-core-badge]: https://img.shields.io/badge/Lean%20Core-Extracted-brightgreen.svg?style=flat-square
[lean-core-issue]: https://github.com/facebook/react-native/issues/23313