Skip to content

Add media navigation hotkeys and confirmation alternative #6934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andersendsa wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add media navigation hotkeys and confirmation alternative #6934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .../ui/src/features/dataset/media-preview/primary-toolbar/hotkeys/hotkeys-list.component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,13 @@ export const HotkeysList = () => {

return (
<Grid columns={['2fr', '1fr']} rowGap={'size-100'}>
<HotkeyItem hotkeyName={'Submit annotations/predictions'} hotkey={formatHotkeyForDisplay(HOTKEYS.submit)} />
<HotkeyItem
hotkeyName={'Submit annotations/predictions'}
hotkey={`${formatHotkeyForDisplay(HOTKEYS.submitAlternative)} or ${formatHotkeyForDisplay(HOTKEYS.submit)}`}
/>
<Divider size='S' gridColumn={'1/-1'} />
<HotkeyItem hotkeyName={'Previous media'} hotkey={'ArrowUp or ArrowLeft'} />
<HotkeyItem hotkeyName={'Next media'} hotkey={'ArrowDown or ArrowRight'} />
<Divider size='S' gridColumn={'1/-1'} />
{availableTools.map((tool) => (
<HotkeyItem key={tool.label} hotkeyName={tool.label} hotkey={formatHotkeyForDisplay(tool.hotkey)} />
Expand Down
2 changes: 1 addition & 1 deletion ...n/ui/src/features/dataset/media-preview/secondary-toolbar/secondary-toolbar.component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ export const SecondaryToolbar = ({
const isSubmitDisabled = (!canSubmit && !hasSubsetChanged) || isSaving || isLoadingPredictions;

useHotkeys(
HOTKEYS.submit,
`${HOTKEYS.submit}, ${HOTKEYS.submitAlternative}`,
(event) => {
event.preventDefault();

Expand Down
28 changes: 25 additions & 3 deletions ...ui/src/features/dataset/media-preview/sidebar-items/use-keyboard-navigation.hook.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,20 @@ describe('useKeyboardNavigation', () => {

it('calls onSelectedMediaItem with previous item on ArrowUp', async () => {
const mockedOnSelectedMediaItem = vi.fn();
render(<App items={items} onSelectedMediaItem={mockedOnSelectedMediaItem} selectedIndex={0} />);
render(<App items={items} onSelectedMediaItem={mockedOnSelectedMediaItem} selectedIndex={1} />);

fireEvent.keyDown(screen.getByTestId('target'), { key: 'ArrowUp' });
expect(mockedOnSelectedMediaItem).toHaveBeenCalledWith(items[0]);
});

it('calls onSelectedMediaItem with previous item on ArrowLeft', async () => {
const mockedOnSelectedMediaItem = vi.fn();
render(<App items={items} onSelectedMediaItem={mockedOnSelectedMediaItem} selectedIndex={1} />);

fireEvent.keyDown(screen.getByTestId('target'), { key: 'ArrowLeft' });
expect(mockedOnSelectedMediaItem).toHaveBeenCalledWith(items[0]);
});

it('calls onSelectedMediaItem with next item on ArrowDown', async () => {
const mockedOnSelectedMediaItem = vi.fn();
render(<App items={items} onSelectedMediaItem={mockedOnSelectedMediaItem} selectedIndex={1} />);
Expand All @@ -35,20 +43,34 @@ describe('useKeyboardNavigation', () => {
expect(mockedOnSelectedMediaItem).toHaveBeenCalledWith(items[2]);
});

it('does not go below index 0 on ArrowUp', async () => {
it('calls onSelectedMediaItem with next item on ArrowRight', async () => {
const mockedOnSelectedMediaItem = vi.fn();
render(<App items={items} onSelectedMediaItem={mockedOnSelectedMediaItem} selectedIndex={1} />);

fireEvent.keyDown(screen.getByTestId('target'), { key: 'ArrowRight' });
expect(mockedOnSelectedMediaItem).toHaveBeenCalledWith(items[2]);
});

it('does not go below index 0 on ArrowUp or ArrowLeft', async () => {
const mockedOnSelectedMediaItem = vi.fn();
render(<App items={items} onSelectedMediaItem={mockedOnSelectedMediaItem} selectedIndex={0} />);

fireEvent.keyDown(screen.getByTestId('target'), { key: 'ArrowUp' });
expect(mockedOnSelectedMediaItem).toHaveBeenCalledWith(items[0]);

fireEvent.keyDown(screen.getByTestId('target'), { key: 'ArrowLeft' });
expect(mockedOnSelectedMediaItem).toHaveBeenCalledWith(items[0]);
});

it('does not go above last index on ArrowDown', async () => {
it('does not go above last index on ArrowDown or ArrowRight', async () => {
const mockedOnSelectedMediaItem = vi.fn();
render(<App items={items} onSelectedMediaItem={mockedOnSelectedMediaItem} selectedIndex={2} />);

fireEvent.keyDown(screen.getByTestId('target'), { key: 'ArrowDown' });
expect(mockedOnSelectedMediaItem).toHaveBeenCalledWith(items[2]);

fireEvent.keyDown(screen.getByTestId('target'), { key: 'ArrowRight' });
expect(mockedOnSelectedMediaItem).toHaveBeenCalledWith(items[2]);
});

it('does not call onSelectedMediaItem for other keys', async () => {
Expand Down
13 changes: 9 additions & 4 deletions ...tion/ui/src/features/dataset/media-preview/sidebar-items/use-keyboard-navigation.hook.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ export const useKeyboardNavigation = ({
selectedIndex,
onSelectedMediaItem,
}: UseKeyboardNavigationProps) => {
const getNewIndex = (key: 'ArrowUp' | 'ArrowDown') => {
if (key === 'ArrowUp') {
const getNewIndex = (key: 'ArrowUp' | 'ArrowDown' | 'ArrowLeft' | 'ArrowRight') => {
if (key === 'ArrowUp' || key === 'ArrowLeft') {
return Math.max(0, selectedIndex - 1);
}

if (key === 'ArrowDown') {
if (key === 'ArrowDown' || key === 'ArrowRight') {
return Math.min(items.length - 1, selectedIndex + 1);
}

Expand All @@ -35,7 +35,12 @@ export const useKeyboardNavigation = ({
useEventListener(
'keydown',
(event) => {
if (event.key === 'ArrowUp' || event.key === 'ArrowDown') {
if (
event.key === 'ArrowUp' ||
event.key === 'ArrowDown' ||
event.key === 'ArrowLeft' ||
event.key === 'ArrowRight'
) {
const newIndex = getNewIndex(event.key);

items[newIndex] && onSelectedMediaItem(items[newIndex]);
Expand Down
1 change: 1 addition & 0 deletions application/ui/src/shared/hotkeys-definition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ export const HOTKEYS = {
selectAllAnnotations: `${CTRL_OR_COMMAND_KEY}+a`,
deselectAllAnnotations: `${CTRL_OR_COMMAND_KEY}+d`,
submit: `${CTRL_OR_COMMAND_KEY}+s`,
submitAlternative: 'enter',
} as const;

const COMMON_HOTKEYS = {
Expand Down