@react-x/clipboard
v3.4.1
Published
Cross-platform clipboard for ReactDOM and React Native apps.
Downloads
1,172
Maintainers
Readme
@react-x/clipboard
Cross-platform clipboard for ReactDOM and React Native apps.
Getting Started
Install @react-x/clipboard
using yarn
:
yarn add @react-x/clipboard
Usage
import React from 'react';
import PropTypes from 'prop-types';
import {Text, Touchable, View} from 'react-native';
import Clipboard from '@react-x/clipboard';
class App extends React.Component {
// --------------------------------------------------
// Props
// --------------------------------------------------
static propTypes = {
user: PropTypes.object.isRequired,
};
static defaultProps = {
};
// --------------------------------------------------
// Event Handlers
// --------------------------------------------------
@bind
handlePress() {
Clipboard.setString(this.props.user.name);
}
// --------------------------------------------------
// Render
// --------------------------------------------------
render() {
return (
<View>
...
<Touchable
onPress={this.handlePress}>
<Text>
{'Copy Name'}
</Text>
</Touchable>
</View>
);
}
}
API
async getString
Returns a promise that resolves to the string currently copied to the clipboard. This currently is not supported on the DOM version. Please submit a PR with this functionality!
async setString(string)
Copies the string
to the clipboard.
Contributing
If you have any ideas on how this module could be better, create an Issue or submit a PR.