Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/react-native-clipboard/clipboard

React Native Clipboard API for both iOS and Android.
https://github.com/react-native-clipboard/clipboard

clipboard hacktoberfest react-native

Last synced: 4 days ago
JSON representation

React Native Clipboard API for both iOS and Android.

Host: GitHub
URL: https://github.com/react-native-clipboard/clipboard
Owner: react-native-clipboard
License: mit
Created: 2019-02-07T10:53:29.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-10-26T00:56:19.000Z (3 months ago)
Last Synced: 2024-10-29T15:26:51.068Z (3 months ago)
Topics: clipboard, hacktoberfest, react-native
Language: TypeScript
Homepage:
Size: 2.63 MB
Stars: 693
Watchers: 7
Forks: 142
Open Issues: 74
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # @react-native-clipboard/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-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.

  For React Native version 0.59 or older

### React Native <= 0.59

run the following command to link the package:

```

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

```

For iOS, make sure you install the pod file.

```

cd ios && pod install && cd ..

```

or you could follow the instructions to [manually link the project](https://reactnative.dev/docs/linking-libraries-ios#manual-linking)

## Upgrading to React Native 0.60+

New React Native comes with `autolinking` feature, which automatically links Native Modules in your project. In order to get it to work, make sure you unlink `Clipboard` first:

```

$ 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:

```javascript

import {Clipboard} from 'react-native';

```

to:

```javascript

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

```

## Example

```jsx

import React, {useState} from 'react';

import {

  SafeAreaView,

  View,

  Text,

  TouchableOpacity,

  StyleSheet,

} from 'react-native';

import Clipboard from '@react-native-clipboard/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

### Clipboard

#### `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();

}

```

#### `getStrings()`

```jsx

static getStrings()

```

(iOS only)

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

```jsx

async _getContent() {

  var content = await Clipboard.getStrings();

}

```

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

#### `setStrings()`

```jsx

static setStrings(content)

```

(iOS only)

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

```jsx

_setContent() {

  Clipboard.setStrings(['hello world', 'second string']);

}

```

#### 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+

#### `hasNumber()`

```jsx

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

```jsx

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

```jsx

import React, {useEffect} from 'react';

import {Text} from 'react-native';

import {useClipboard} from '@react-native-clipboard/clipboard';

export const HooksSample = () => {

  const [data, setString] = useClipboard();

  useEffect(() => {

    setString('hello world');

  }, []);

  return {data};

};

```

### `getImage()`

```jsx

static 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)

```jsx

async _getContent() {

  var content = await Clipboard.getImage();

}

```

## 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:

```js

import mockClipboard from '@react-native-clipboard/clipboard/jest/clipboard-mock.js';

jest.mock('@react-native-clipboard/clipboard', () => mockClipboard);

```

## Maintainers

- [M.Haris Baig](https://github.com/harisbaig100)

- [Jesse Katsumata](https://github.com/Naturalclar)

## Contributing

Please see the [`contributing guide`](/CONTRIBUTING.md).

## License

The library is released under the MIT licence. For more information see [`LICENSE`](/LICENSE).

[build-badge]: https://github.com/react-native-clipboard/clipboard/workflows/Build/badge.svg

[build]: https://github.com/react-native-clipboard/clipboard/actions

[version-badge]: https://img.shields.io/npm/v/@react-native-clipboard/clipboard.svg?style=flat-square

[package]: https://www.npmjs.com/package/@react-native-clipboard/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-clipboard/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