feat(compass-components): add context menu COMPASS-9386 #6956
+553
−189
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,166 @@ | ||
| import React from 'react'; | ||
| import { render, screen, userEvent } from '@mongodb-js/testing-library-compass'; | ||
| import { expect } from 'chai'; | ||
| import sinon from 'sinon'; | ||
| import { ContextMenuProvider } from '@mongodb-js/compass-context-menu'; | ||
| import { useContextMenuItems, ContextMenu } from './context-menu'; | ||
| import type { ContextMenuItem } from '@mongodb-js/compass-context-menu'; | ||
|
|
||
| describe('useContextMenuItems', function () { | ||
|
There was a problem hiding this comment. We might be missing a test to ensure the menu closes once clicked? |
||
| const menuTestTriggerId = 'test-trigger'; | ||
|
|
||
| const TestComponent = ({ | ||
| items, | ||
| children, | ||
| 'data-testid': dataTestId = menuTestTriggerId, | ||
| }: { | ||
| items: ContextMenuItem[]; | ||
| children?: React.ReactNode; | ||
| 'data-testid'?: string; | ||
| }) => { | ||
| const ref = useContextMenuItems(() => items, [items]); | ||
|
|
||
| return ( | ||
| <div data-testid={dataTestId} ref={ref}> | ||
| Test Component | ||
| {children} | ||
| </div> | ||
| ); | ||
| }; | ||
|
|
||
| it('works with nested providers, using the parent provider', function () { | ||
| const items = [ | ||
| { | ||
| label: 'Test Item', | ||
| onAction: () => {}, | ||
| }, | ||
| ]; | ||
|
|
||
| const { container } = render( | ||
| <ContextMenuProvider menuWrapper={ContextMenu}> | ||
| <ContextMenuProvider menuWrapper={ContextMenu}> | ||
| <TestComponent items={items} /> | ||
| </ContextMenuProvider> | ||
| </ContextMenuProvider> | ||
| ); | ||
|
|
||
| // Should only find one context menu (from the parent provider) | ||
| expect( | ||
| container.querySelectorAll('[data-testid="context-menu"]') | ||
| ).to.have.length(1); | ||
| // Should still render the trigger | ||
| expect(screen.getByTestId(menuTestTriggerId)).to.exist; | ||
| }); | ||
|
|
||
| it('renders without error', function () { | ||
| const items = [ | ||
| { | ||
| label: 'Test Item', | ||
| onAction: () => {}, | ||
| }, | ||
| ]; | ||
|
|
||
| render(<TestComponent items={items} />); | ||
|
|
||
| expect(screen.getByTestId(menuTestTriggerId)).to.exist; | ||
| }); | ||
|
|
||
| it('shows context menu with items on right click', function () { | ||
| const items = [ | ||
| { | ||
| label: 'Test Item 1', | ||
| onAction: () => {}, | ||
| }, | ||
| { | ||
| label: 'Test Item 2', | ||
| onAction: () => {}, | ||
| }, | ||
| ]; | ||
|
|
||
| render(<TestComponent items={items} />); | ||
|
|
||
| const trigger = screen.getByTestId(menuTestTriggerId); | ||
| userEvent.click(trigger, { button: 2 }); | ||
|
|
||
| // The menu items should be rendered | ||
| expect(screen.getByTestId('menu-group-0-item-0')).to.exist; | ||
| expect(screen.getByTestId('menu-group-0-item-1')).to.exist; | ||
| }); | ||
|
|
||
| it('triggers the correct action when menu item is clicked', function () { | ||
| const onAction = sinon.spy(); | ||
| const items = [ | ||
| { | ||
| label: 'Test Item 1', | ||
| onAction: () => onAction(1), | ||
| }, | ||
| { | ||
| label: 'Test Item 2', | ||
| onAction: () => onAction(2), | ||
| }, | ||
| ]; | ||
|
|
||
| render(<TestComponent items={items} />); | ||
|
|
||
| const trigger = screen.getByTestId(menuTestTriggerId); | ||
| userEvent.click(trigger, { button: 2 }); | ||
|
|
||
| const menuItem = screen.getByTestId('menu-group-0-item-1'); | ||
| userEvent.click(menuItem); | ||
|
|
||
| expect(onAction).to.have.been.calledOnceWithExactly(2); | ||
| }); | ||
|
|
||
| describe('with nested components', function () { | ||
| const childTriggerId = 'child-trigger'; | ||
|
|
||
| beforeEach(function () { | ||
| const items = [ | ||
| { | ||
| label: 'Test Item 1', | ||
| onAction: () => {}, | ||
| }, | ||
| { | ||
| label: 'Test Item 2', | ||
| onAction: () => {}, | ||
| }, | ||
| ]; | ||
|
|
||
| const childItems = [ | ||
| { | ||
| label: 'Child Item 1', | ||
| onAction: () => {}, | ||
| }, | ||
| ]; | ||
|
|
||
| render( | ||
| <TestComponent items={items}> | ||
| <TestComponent items={childItems} data-testid={childTriggerId} /> | ||
| </TestComponent> | ||
| ); | ||
| }); | ||
|
|
||
| it('renders menu items with separators', function () { | ||
| const trigger = screen.getByTestId(childTriggerId); | ||
| userEvent.click(trigger, { button: 2 }); | ||
|
|
||
| // Should find the menu item and the separator | ||
| expect(screen.getByTestId('menu-group-0').children.length).to.equal(2); | ||
| expect( | ||
| screen.getByTestId('menu-group-0').children.item(0)?.textContent | ||
| ).to.equal('Child Item 1'); | ||
|
|
||
| expect(screen.getByTestId('menu-group-0-separator')).to.exist; | ||
|
|
||
| expect(screen.getByTestId('menu-group-1').children.length).to.equal(2); | ||
| expect( | ||
| screen.getByTestId('menu-group-1').children.item(0)?.textContent | ||
| ).to.equal('Test Item 1'); | ||
| expect( | ||
| screen.getByTestId('menu-group-1').children.item(1)?.textContent | ||
| ).to.equal('Test Item 2'); | ||
|
|
||
| expect(screen.queryByTestId('menu-group-1-separator')).not.to.exist; | ||
| }); | ||
| }); | ||
| }); | ||
This file contains hidden or 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,102 @@ | ||
| import React, { useEffect, useMemo, useRef } from 'react'; | ||
| import { Menu, MenuItem, MenuSeparator } from './leafygreen'; | ||
| import type { ContextMenuItem } from '@mongodb-js/compass-context-menu'; | ||
| import { useContextMenu } from '@mongodb-js/compass-context-menu'; | ||
| import { ContextMenuProvider as ContextMenuProviderBase } from '@mongodb-js/compass-context-menu'; | ||
| import type { | ||
| ContextMenuItemGroup, | ||
| ContextMenuWrapperProps, | ||
| } from '@mongodb-js/compass-context-menu'; | ||
|
|
||
| export function ContextMenuProvider({ | ||
| children, | ||
| }: { | ||
| children: React.ReactNode; | ||
| }) { | ||
| return ( | ||
| <ContextMenuProviderBase menuWrapper={ContextMenu}> | ||
| {children} | ||
| </ContextMenuProviderBase> | ||
| ); | ||
| } | ||
|
|
||
| export function ContextMenu({ menu }: ContextMenuWrapperProps) { | ||
| const menuRef = useRef(null); | ||
|
|
||
| const position = menu.position; | ||
| const itemGroups = menu.itemGroups; | ||
|
|
||
| useEffect(() => { | ||
| if (!menu.isOpen) { | ||
| menu.close(); | ||
| } | ||
| }, [menu.isOpen]); | ||
|
|
||
| return ( | ||
| <div | ||
| data-testid="context-menu" | ||
| style={{ | ||
| position: 'absolute', | ||
| left: position.x, | ||
| top: position.y, | ||
| // This is to ensure the menu gets positioned correctly as the left and top updates | ||
| width: 1, | ||
| height: 1, | ||
| }} | ||
| > | ||
| <Menu | ||
| ref={menuRef} | ||
| open={menu.isOpen} | ||
| setOpen={menu.close} | ||
| justify="start" | ||
| > | ||
| {itemGroups.map( | ||
| (itemGroup: ContextMenuItemGroup, groupIndex: number) => { | ||
| return ( | ||
| <div | ||
| key={`menu-group-${groupIndex}`} | ||
| data-testid={`menu-group-${groupIndex}`} | ||
| > | ||
| {itemGroup.items.map( | ||
| (item: ContextMenuItem, itemIndex: number) => { | ||
| return ( | ||
| <MenuItem | ||
| key={`menu-group-${groupIndex}-item-${itemIndex}`} | ||
| data-text={item.label} | ||
| data-testid={`menu-group-${groupIndex}-item-${itemIndex}`} | ||
| onClick={(evt: React.MouseEvent) => { | ||
| item.onAction?.(evt); | ||
| menu.close(); | ||
| }} | ||
| > | ||
| {item.label} | ||
| </MenuItem> | ||
| ); | ||
| } | ||
| )} | ||
| {groupIndex < itemGroups.length - 1 && ( | ||
| <div | ||
| key={`menu-group-${groupIndex}-separator`} | ||
| data-testid={`menu-group-${groupIndex}-separator`} | ||
| > | ||
| <MenuSeparator /> | ||
| </div> | ||
| )} | ||
| </div> | ||
| ); | ||
| } | ||
| )} | ||
| </Menu> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| export function useContextMenuItems( | ||
| getItems: () => ContextMenuItem[], | ||
| dependencies: React.DependencyList | undefined | ||
| ): React.RefCallback<HTMLElement> { | ||
| // eslint-disable-next-line react-hooks/exhaustive-deps | ||
| const memoizedItems = useMemo(getItems, dependencies); | ||
| const contextMenu = useContextMenu(); | ||
Anemy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return contextMenu.registerItems(memoizedItems); | ||
| } | ||
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
one might want to keep this empty... the reason the context menu always exists even when closed is for the sake of animations