Adds a copy-to-clipboard button for each annotation so that text can be copied easily. This re-uses the existing `CopyToClipboard` component and adds a `small` variant that can be used inline. The icon size and colour have been chosen to avoid being overwhelming when used inline. Related to #30141 I opted not to introduce the hover behaviour from #30749 as it's less discoverable, but can understand why that might be favourable. Certainly open to suggestions 😄 <img width="379" alt="Screenshot 2024-07-22 at 3 23 53 PM" src="https://github.com/user-attachments/assets/3b9998cf-2e8d-40c9-9c8a-64eab3a9ed2e">
60 lines
1.9 KiB
TypeScript
60 lines
1.9 KiB
TypeScript
/**
|
|
* Copyright (c) Microsoft Corporation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import * as React from 'react';
|
|
import * as icons from './icons';
|
|
import './copyToClipboard.css';
|
|
|
|
type CopyToClipboardProps = {
|
|
value: string;
|
|
};
|
|
|
|
/**
|
|
* A copy to clipboard button.
|
|
*/
|
|
export const CopyToClipboard: React.FunctionComponent<CopyToClipboardProps> = ({ value }) => {
|
|
type IconType = 'copy' | 'check' | 'cross';
|
|
const [icon, setIcon] = React.useState<IconType>('copy');
|
|
const handleCopy = React.useCallback(() => {
|
|
navigator.clipboard.writeText(value).then(() => {
|
|
setIcon('check');
|
|
setTimeout(() => {
|
|
setIcon('copy');
|
|
}, 3000);
|
|
}, () => {
|
|
setIcon('cross');
|
|
});
|
|
}, [value]);
|
|
const iconElement = icon === 'check' ? icons.check() : icon === 'cross' ? icons.cross() : icons.copy();
|
|
return <button className='copy-icon' aria-label='Copy to clipboard' onClick={handleCopy}>{iconElement}</button>;
|
|
};
|
|
|
|
type CopyToClipboardContainerProps = CopyToClipboardProps & {
|
|
children: React.ReactNode
|
|
};
|
|
|
|
/**
|
|
* Container for displaying a copy to clipboard button alongside children.
|
|
*/
|
|
export const CopyToClipboardContainer: React.FunctionComponent<CopyToClipboardContainerProps> = ({ children, value }) => {
|
|
return <span className='copy-value-container'>
|
|
{children}
|
|
<span className='copy-button-container'>
|
|
<CopyToClipboard value={value} />
|
|
</span>
|
|
</span>;
|
|
};
|