File size: 1,702 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
# Clipboard Button Input
Clipboard Button Input is a React component used to display a text input field containing a button for copying the value of the input to a user's clipboard. It makes use of the [Clipboard Button component](../forms/clipboard-button), which leverages [Clipboard.js](https://github.com/zenorocha/clipboard.js) for non-Flash based copy behavior.
## Usage
In most cases, the component can be treated much like any other text input element. Pass a `value` to be used as the input text to be copied.
```jsx
import ClipboardButtonInput from 'calypso/components/clipboard-button-input';
export default function MyComponent() {
return <ClipboardButtonInput value="https://example.wordpress.com/" />;
}
```
## Props
The following props can be passed to the ClipboardButtonInput component. With the exception of `className`, all props, including those not listed below, will be passed to the child `<input />` element.
| property | type | required | default | comment |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `value` | String | no | `""` | The value of the `<input />` element, and the text to be copied when clicking the copy button. |
| `disabled` | Boolean | no | `false` | Whether the children `<input />` and `<button />` should be rendered as `disabled`. |
| `hideHttp` | Boolean | no | `false` | Allows URLs to be shown without `http://` or `https://` while keeping the scheme in the copyable value. |
|