-
Notifications
You must be signed in to change notification settings - Fork 192
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: copy link button for search (#1120)
* Proper CopyLinkWrapper component directory established * Unit tests for CopyLinkWrapper * Refactored HTML for button layout * Documentation in CopyLinkWrapper * Added support for extension framework * Testing for extension framework Co-authored-by: John Kaster <kaster@google.com>
- Loading branch information
Showing
10 changed files
with
295 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 107 additions & 0 deletions
107
packages/run-it/src/components/CopyLinkWrapper/CopyLinkWrapper.spec.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /* | ||
| MIT License | ||
| Copyright (c) 2021 Looker Data Sciences, Inc. | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| */ | ||
|
|
||
| import { renderWithTheme } from '@looker/components-test-utils' | ||
| import { screen, waitFor } from '@testing-library/react' | ||
| import React from 'react' | ||
| import userEvent from '@testing-library/user-event' | ||
| import { BrowserAdaptor, registerTestEnvAdaptor } from '@looker/extension-utils' | ||
| import { CopyLinkWrapper } from './index' | ||
| import { initRunItSdk } from '@looker/run-it' | ||
|
|
||
| jest.mock('react-router-dom', () => { | ||
| const ReactRouterDOM = jest.requireActual('react-router-dom') | ||
| return { | ||
| ...ReactRouterDOM, | ||
| useLocation: () => ({ | ||
| pathname: location.pathname, | ||
| search: location.search, | ||
| }), | ||
| } | ||
| }) | ||
|
|
||
| describe('CopyLinkWrapper', () => { | ||
| test('it renders and hides button upon mouse hover', () => { | ||
| renderWithTheme( | ||
| <CopyLinkWrapper> | ||
| <div>test</div> | ||
| </CopyLinkWrapper> | ||
| ) | ||
| const div = screen.getByText('test') | ||
| userEvent.hover(div) | ||
| expect(screen.queryByRole('button')).toBeInTheDocument() | ||
| userEvent.unhover(div) | ||
| expect(screen.queryByRole('button')).not.toBeInTheDocument() | ||
| }) | ||
|
|
||
| const mockClipboardCopy = jest | ||
| .fn() | ||
| .mockImplementation(() => Promise.resolve()) | ||
| Object.assign(navigator, { | ||
| clipboard: { | ||
| writeText: mockClipboardCopy, | ||
| }, | ||
| }) | ||
|
|
||
| test('it copies to clipboard', async () => { | ||
| registerTestEnvAdaptor() | ||
| jest.spyOn(navigator.clipboard, 'writeText') | ||
| renderWithTheme( | ||
| <CopyLinkWrapper visible={true}> | ||
| <div>test</div> | ||
| </CopyLinkWrapper> | ||
| ) | ||
| const div = screen.getByText('test') | ||
| userEvent.hover(div) | ||
| await waitFor(() => { | ||
| userEvent.click(screen.getByRole('button')) | ||
| expect(mockClipboardCopy).toHaveBeenCalledWith(location.href) | ||
| }) | ||
| }) | ||
|
|
||
| test('it updates tooltip content upon copy', async () => { | ||
| const sdk = initRunItSdk() | ||
| registerTestEnvAdaptor(new BrowserAdaptor(sdk)) | ||
| renderWithTheme( | ||
| <CopyLinkWrapper visible={true}> | ||
| <div>test</div> | ||
| </CopyLinkWrapper> | ||
| ) | ||
| const div = screen.getByText('test') | ||
| userEvent.hover(div) | ||
| const button = screen.getByRole('button') | ||
| await waitFor(() => { | ||
| userEvent.hover(button) | ||
| expect(screen.getByText('Copy to clipboard')).toBeInTheDocument() | ||
| }) | ||
| await waitFor(() => { | ||
| userEvent.click(screen.getByRole('button')) | ||
| expect(mockClipboardCopy).toHaveBeenCalledWith(location.href) | ||
| userEvent.hover(button) | ||
| expect(screen.getAllByText('Copied to clipboard')[0]).toBeVisible() | ||
| }) | ||
| }) | ||
| }) |
79 changes: 79 additions & 0 deletions
79
packages/run-it/src/components/CopyLinkWrapper/CopyLinkWrapper.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /* | ||
| MIT License | ||
| Copyright (c) 2021 Looker Data Sciences, Inc. | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| */ | ||
| import type { ReactNode, ReactNodeArray } from 'react' | ||
| import React, { useState } from 'react' | ||
| import { IconButton, Space } from '@looker/components' | ||
| import { Link } from '@styled-icons/material-outlined/Link' | ||
| import { getEnvAdaptor } from '@looker/extension-utils' | ||
| import { useLocation } from 'react-router-dom' | ||
|
|
||
| interface CopyLinkWrapperProps { | ||
| children: ReactNode | ReactNodeArray | ||
| visible?: boolean | ||
| } | ||
|
|
||
| const COPY_TO_CLIPBOARD = 'Copy to clipboard' | ||
|
|
||
| /** | ||
| * Displays a copy link button on hover | ||
| * | ||
| * @param children component(s) which will render left of the button | ||
| * @param visible boolean determining button visibility | ||
| */ | ||
| export const CopyLinkWrapper = ({ | ||
| children, | ||
| visible = true, | ||
| }: CopyLinkWrapperProps) => { | ||
| const [tooltipContent, setTooltipContent] = useState(COPY_TO_CLIPBOARD) | ||
| const [showCopyLinkButton, setShowCopyLinkButton] = useState(false) | ||
| const location = useLocation() | ||
| const handleCopyLink = async () => { | ||
| await getEnvAdaptor().copyToClipboard(location) | ||
| setTooltipContent('Copied to clipboard') | ||
| } | ||
| const handleMouseLeave = () => { | ||
| setTooltipContent(COPY_TO_CLIPBOARD) | ||
| } | ||
| return ( | ||
| <Space | ||
| width={'100%'} | ||
| onMouseEnter={() => setShowCopyLinkButton(true)} | ||
| onMouseLeave={() => setShowCopyLinkButton(false)} | ||
| > | ||
| {children} | ||
| {showCopyLinkButton && visible && ( | ||
| <IconButton | ||
| onClick={handleCopyLink} | ||
| icon={<Link />} | ||
| size="small" | ||
| label={tooltipContent} | ||
| tooltipPlacement="bottom" | ||
| onMouseLeave={handleMouseLeave} | ||
| /> | ||
| )} | ||
| </Space> | ||
| ) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /* | ||
| MIT License | ||
| Copyright (c) 2021 Looker Data Sciences, Inc. | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| */ | ||
| export { CopyLinkWrapper } from './CopyLinkWrapper' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters