Expo ClipboardA universal library that allows getting and setting Clipboard content.
expo-clipboard provides an interface for getting and setting Clipboard content on Android, iOS, and Web.
Installation
- npx expo install expo-clipboardIf you are installing this in an existing React Native app, make sure to install expo in your project.
Usage
import { useState } from 'react';
import { View, Text, Button, StyleSheet } from 'react-native';
import * as Clipboard from 'expo-clipboard';
export default function App() {
const [copiedText, setCopiedText] = useState('');
const copyToClipboard = async () => {
await Clipboard.setStringAsync('hello world');
};
const fetchCopiedText = async () => {
const text = await Clipboard.getStringAsync();
setCopiedText(text);
};
return (
<View style={styles.container}>
<Button title="Click here to copy to Clipboard" onPress={copyToClipboard} />
<Button title="View copied text" onPress={fetchCopiedText} />
<Text style={styles.copiedText}>{copiedText}</Text>
</View>
);
}
const styles = StyleSheet.create({
container: {
flex: 1,
justifyContent: 'center',
alignItems: 'center',
},
copiedText: {
marginTop: 10,
color: 'red',
},
});
API
import * as Clipboard from 'expo-clipboard';
On Web, this module uses theAsyncClipboardAPI, which might behave differently between browsers or not be fully supported. Especially on WebKit, there's an issue which makes this API unusable in asynchronous code. Click here for more details.
Component
Type: React.Element<ClipboardPasteButtonProps>
This component displays the UIPasteControl button on your screen. This allows pasting from the clipboard without requesting permission from the user.
You should only attempt to render this if Clipboard.isPasteButtonAvailable
is true. This component will render nothing if it is not available, and you will get
a warning in development mode (__DEV__ === true).
The properties of this component extend from View; however, you should not attempt to set
backgroundColor, color or borderRadius with the style property. Apple restricts customisation of this view.
Instead, you should use the backgroundColor and foregroundColor properties to set the colors of the button, the cornerStyle property to change the border radius,
and the displayMode property to change the appearance of the icon and label. The word "Paste" is not editable and neither is the icon.
Make sure to attach height and width via the style props as without these styles, the button will not appear on the screen.
See: Apple Documentation for more details.
AcceptedContentType[] • Default: ['plain-text', 'image']An array of the content types that will cause the button to become active.
Do not include
plain-textandhtmlat the same time as this will cause all text to be treated ashtml.
unionThe backgroundColor of the button. Leaving this as the default allows the color to adjust to the system theme settings.
Acceptable values are: string | null
union • Default: 'capsule'The cornerStyle of the button.
See: Apple Documentation for more details.
Acceptable values are: CornerStyleType | null
union • Default: 'iconAndLabel'The displayMode of the button.
See: Apple Documentation for more details.
Acceptable values are: DisplayModeType | null
union • Default: 'white'The foregroundColor of the button.
Acceptable values are: string | null
unionThe options to use when pasting an image from the clipboard.
Acceptable values are: GetImageOptions | null
(data: PasteEventPayload) => voidA callback that is called with the result of the paste action.
Inspect the type property to determine the type of the pasted data.
Can be one of text or image.
Example
onPress={(data) => {
if (data.type === 'image') {
setImageData(data);
} else {
setTextData(data);
}
}}
The custom style to apply to the button. Should not include backgroundColor, borderRadius or color
properties.
Constants
Type: boolean
Property that determines if the ClipboardPasteButton is available.
This requires the users device to be using at least iOS 16.
true if the component is available, and false otherwise.
Methods
| Parameter | Type | Description |
|---|---|---|
| options | GetImageOptions | A |
Gets the image from the user's clipboard and returns it in the specified format. Please note that calling this method on web will prompt the user to grant your app permission to "see text and images copied to the clipboard."
Promise<ClipboardImage | null>If there was an image in the clipboard, the promise resolves to
a ClipboardImage object containing the base64 string and metadata of the image.
Otherwise, it resolves to null.
Example
const img = await Clipboard.getImageAsync({ format: 'png' });
// ...
<Image source={{ uri: img?.data }} style={{ width: 200, height: 200 }} />
| Parameter | Type | Description |
|---|---|---|
| options(optional) | GetStringOptions | Options for the clipboard content to be retrieved. Default: {} |
Gets the content of the user's clipboard. Please note that calling this method on web will prompt the user to grant your app permission to "see text and images copied to the clipboard."
Promise<string>A promise that resolves to the content of the clipboard.
Gets the URL from the user's clipboard.
Promise<string | null>A promise that fulfills to the URL in the clipboard.
Returns whether the clipboard has an image content.
On web, this requires the user to grant your app permission to "see text and images copied to the clipboard".
Promise<boolean>A promise that fulfills to true if clipboard has image content, resolves to false otherwise.
Returns whether the clipboard has text content. Returns true for both plain text and rich text (e.g. HTML).
On web, this requires the user to grant your app permission to "see text and images copied to the clipboard".
Promise<boolean>A promise that fulfills to true if clipboard has text content, resolves to false otherwise.
Returns whether the clipboard has a URL content.
Promise<boolean>A promise that fulfills to true if clipboard has URL content, resolves to false otherwise.
| Parameter | Type | Description |
|---|---|---|
| base64Image | string | Image encoded as a base64 string, without MIME type. |
Sets an image in the user's clipboard.
Promise<void>Example
const result = await ImagePicker.launchImageLibraryAsync({
mediaTypes: ImagePicker.MediaTypeOptions.Images,
base64: true,
});
await Clipboard.setImageAsync(result.base64);
Deprecated Use
setStringAsync()instead.
| Parameter | Type |
|---|---|
| text | string |
Sets the content of the user's clipboard.
voidOn web, this returns a boolean value indicating whether or not the string was saved to the user's clipboard. On iOS and Android, nothing is returned.
| Parameter | Type | Description |
|---|---|---|
| text | string | The string to save to the clipboard. |
| options(optional) | SetStringOptions | Options for the clipboard content to be set. Default: {} |
Sets the content of the user's clipboard.
Promise<boolean>On web, this returns a promise that fulfills to a boolean value indicating whether or not
the string was saved to the user's clipboard. On iOS and Android, the promise always resolves to true.
| Parameter | Type | Description |
|---|---|---|
| url | string | The URL to save to the clipboard. |
Sets a URL in the user's clipboard.
This function behaves the same as setStringAsync(), except that
it sets the clipboard content type to be a URL. It lets your app or other apps know that the
clipboard contains a URL and behave accordingly.
Promise<void>Event Subscriptions
| Parameter | Type | Description |
|---|---|---|
| listener | (event: ClipboardEvent) => void | Callback to execute when listener is triggered. The callback is provided a single argument that is an object containing information about clipboard contents. |
Adds a listener that will fire whenever the content of the user's clipboard changes. This method is a no-op on Web.
EventSubscriptionExample
Clipboard.addClipboardListener(({ contentTypes }: ClipboardEvent) => {
if (contentTypes.includes(Clipboard.ContentType.PLAIN_TEXT)) {
Clipboard.getStringAsync().then(content => {
alert('Copy pasta! Here\'s the string that was copied: ' + content)
});
} else if (contentTypes.includes(Clipboard.ContentType.IMAGE)) {
alert('Yay! Clipboard contains an image');
}
});
| Parameter | Type | Description |
|---|---|---|
| subscription | EventSubscription | The subscription to remove (created by addClipboardListener). |
Removes the listener added by addClipboardListener. This method is a no-op on Web.
voidExample
const subscription = addClipboardListener(() => {
alert('Copy pasta!');
});
removeClipboardListener(subscription);
Interfaces
A subscription object that allows to conveniently remove an event listener from the emitter.
Types
Literal Type: string
Acceptable values are: 'plain-text' | 'image' | 'url' | 'html'
| Property | Type | Description |
|---|---|---|
| content | string |
|
| contentTypes | ContentType[] | An array of content types that are available on the clipboard. |
| Property | Type | Description |
|---|---|---|
| data | string | A Base64-encoded string of the image data. Its format is dependent on the
Example |
| size | {
height: number,
width: number
} | Dimensions ( |
Literal Type: string
Acceptable values are: 'dynamic' | 'fixed' | 'capsule' | 'large' | 'medium' | 'small'
Literal Type: string
Acceptable values are: 'iconAndLabel' | 'iconOnly' | 'labelOnly'
| Property | Type | Description |
|---|---|---|
| format | 'png' | 'jpeg' | The format of the clipboard image to be converted to. |
| jpegQuality(optional) | number | Specify the quality of the returned image, between Default: 1 |
| Property | Type | Description |
|---|---|---|
| preferredFormat(optional) | StringFormat | The target format of the clipboard string to be converted to, if possible. Default: StringFormat.PLAIN_TEXT |
Literal Type: union
Acceptable values are: TextPasteEvent | ImagePasteEvent
| Property | Type | Description |
|---|---|---|
| inputFormat(optional) | StringFormat | The input format of the provided string. Adjusting this option can help other applications interpret copied string properly. Default: StringFormat.PLAIN_TEXT |
Enums
Type used to define what type of data is stored in the clipboard.