diff options
author | Jeremy Davis <jeremy.davis@sonarsource.com> | 2023-02-22 16:18:48 +0100 |
---|---|---|
committer | sonartech <sonartech@sonarsource.com> | 2023-03-13 20:02:44 +0000 |
commit | b33a7cd2193a47f90b22568dd0d58f404bc5f6d7 (patch) | |
tree | 6ad602cc5b4172f048a17ef33ed0267c8d96aed5 /server/sonar-web/design-system/src/components/clipboard.tsx | |
parent | 8d902e9e2484b35b7a9fe6e8ed49e68ad3ff6ab5 (diff) | |
download | sonarqube-b33a7cd2193a47f90b22568dd0d58f404bc5f6d7.tar.gz sonarqube-b33a7cd2193a47f90b22568dd0d58f404bc5f6d7.zip |
SONAR-18524 New Main App bar
Diffstat (limited to 'server/sonar-web/design-system/src/components/clipboard.tsx')
-rw-r--r-- | server/sonar-web/design-system/src/components/clipboard.tsx | 170 |
1 files changed, 170 insertions, 0 deletions
diff --git a/server/sonar-web/design-system/src/components/clipboard.tsx b/server/sonar-web/design-system/src/components/clipboard.tsx new file mode 100644 index 00000000000..ea05963f772 --- /dev/null +++ b/server/sonar-web/design-system/src/components/clipboard.tsx @@ -0,0 +1,170 @@ +/* + * SonarQube + * Copyright (C) 2009-2023 SonarSource SA + * mailto:info AT sonarsource DOT com + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +import classNames from 'classnames'; +import Clipboard from 'clipboard'; +import React from 'react'; +import { INTERACTIVE_TOOLTIP_DELAY } from '../helpers/constants'; +import { translate } from '../helpers/l10n'; +import { ButtonSecondary } from './buttons'; +import CopyIcon from './icons/CopyIcon'; +import { IconProps } from './icons/Icon'; +import { DiscreetInteractiveIcon, InteractiveIcon, InteractiveIconSize } from './InteractiveIcon'; +import Tooltip from './Tooltip'; + +const COPY_SUCCESS_NOTIFICATION_LIFESPAN = 1000; + +export interface State { + copySuccess: boolean; +} + +interface RenderProps { + copySuccess: boolean; + setCopyButton: (node: HTMLElement | null) => void; +} + +interface BaseProps { + children: (props: RenderProps) => React.ReactNode; +} + +export class ClipboardBase extends React.PureComponent<BaseProps, State> { + private clipboard?: Clipboard; + private copyButton?: HTMLElement | null; + mounted = false; + state: State = { copySuccess: false }; + + componentDidMount() { + this.mounted = true; + if (this.copyButton) { + this.clipboard = new Clipboard(this.copyButton); + this.clipboard.on('success', this.handleSuccessCopy); + } + } + + componentDidUpdate() { + if (this.clipboard) { + this.clipboard.destroy(); + } + if (this.copyButton) { + this.clipboard = new Clipboard(this.copyButton); + this.clipboard.on('success', this.handleSuccessCopy); + } + } + + componentWillUnmount() { + this.mounted = false; + if (this.clipboard) { + this.clipboard.destroy(); + } + } + + setCopyButton = (node: HTMLElement | null) => { + this.copyButton = node; + }; + + handleSuccessCopy = () => { + if (this.mounted) { + this.setState({ copySuccess: true }); + setTimeout(() => { + if (this.mounted) { + this.setState({ copySuccess: false }); + } + }, COPY_SUCCESS_NOTIFICATION_LIFESPAN); + } + }; + + render() { + return this.props.children({ + setCopyButton: this.setCopyButton, + copySuccess: this.state.copySuccess, + }); + } +} + +interface ButtonProps { + children?: React.ReactNode; + className?: string; + copyValue: string; + icon?: React.ReactNode; +} + +export function ClipboardButton({ + icon = <CopyIcon />, + className, + children, + copyValue, +}: ButtonProps) { + return ( + <ClipboardBase> + {({ setCopyButton, copySuccess }) => ( + <Tooltip overlay={translate('copied_action')} visible={copySuccess}> + <ButtonSecondary + className={classNames('sw-select-none', className)} + data-clipboard-text={copyValue} + icon={icon} + innerRef={setCopyButton} + > + {children || translate('copy')} + </ButtonSecondary> + </Tooltip> + )} + </ClipboardBase> + ); +} + +interface IconButtonProps { + Icon?: React.ComponentType<IconProps>; + 'aria-label'?: string; + className?: string; + copyValue: string; + discreet?: boolean; + size?: InteractiveIconSize; +} + +export function ClipboardIconButton(props: IconButtonProps) { + const { className, copyValue, discreet, size = 'small', Icon = CopyIcon } = props; + const InteractiveIconComponent = discreet ? DiscreetInteractiveIcon : InteractiveIcon; + + return ( + <ClipboardBase> + {({ setCopyButton, copySuccess }) => { + return ( + <Tooltip + mouseEnterDelay={INTERACTIVE_TOOLTIP_DELAY} + overlay={ + <div className="sw-w-abs-150 sw-text-center"> + {translate(copySuccess ? 'copied_action' : 'copy_to_clipboard')} + </div> + } + {...(copySuccess ? { visible: copySuccess } : undefined)} + > + <InteractiveIconComponent + Icon={Icon} + aria-label={props['aria-label'] ?? translate('copy_to_clipboard')} + className={className} + data-clipboard-text={copyValue} + innerRef={setCopyButton} + size={size} + /> + </Tooltip> + ); + }} + </ClipboardBase> + ); +} |