0
0
mirror of https://github.com/go-gitea/gitea.git synced 2026-05-16 23:27:40 +02:00
gitea/tests/e2e/repo-shortcuts.test.e2e.ts
micahkepe 7226ecde9a feat(shortcut): Add keyboard shortcuts for repository file and code search
Add GitHub-like keyboard shortcuts for repository navigation:
- Press 'T' to focus the "Go to file" search input
- Press 'S' to focus the "Search code" input
- Press 'Escape' to blur focused search inputs

Both search inputs display a keyboard hint (kbd element) showing
the available shortcut. The hint hides when the input is focused
or has a value.

Includes unit tests and e2e tests for the new functionality.
2026-02-14 22:43:52 -08:00

147 lines
5.6 KiB
TypeScript

// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
import {test, expect} from '@playwright/test';
import {login_user, load_logged_in_context} from './utils_e2e.ts';
test.beforeAll(async ({browser}, workerInfo) => {
await login_user(browser, workerInfo, 'user2');
});
test.describe('Repository Keyboard Shortcuts', () => {
test('T key focuses file search input', async ({browser}, workerInfo) => {
const context = await load_logged_in_context(browser, workerInfo, 'user2');
const page = await context.newPage();
// Navigate to a repository page with file listing
await page.goto('/user2/repo1');
await page.waitForLoadState('networkidle'); // eslint-disable-line playwright/no-networkidle
// Verify the file search input exists and has the keyboard hint
const fileSearchInput = page.locator('.repo-file-search-container input');
await expect(fileSearchInput).toBeVisible();
// Verify the keyboard hint is visible
const kbdHint = page.locator('.repo-file-search-input-wrapper kbd');
await expect(kbdHint).toBeVisible();
await expect(kbdHint).toHaveText('T');
// Press T key to focus the file search input
await page.keyboard.press('t');
// Verify the input is focused
await expect(fileSearchInput).toBeFocused();
});
test('T key does not trigger when typing in input', async ({browser}, workerInfo) => {
const context = await load_logged_in_context(browser, workerInfo, 'user2');
const page = await context.newPage();
// Navigate to a repository page
await page.goto('/user2/repo1');
await page.waitForLoadState('networkidle'); // eslint-disable-line playwright/no-networkidle
// Focus on file search first
const fileSearchInput = page.locator('.repo-file-search-container input');
await fileSearchInput.click();
// Type something including 't'
await page.keyboard.type('test');
// Verify the input still has focus and contains the typed text
await expect(fileSearchInput).toBeFocused();
await expect(fileSearchInput).toHaveValue('test');
});
test('S key focuses code search input on repo home', async ({browser}, workerInfo) => {
const context = await load_logged_in_context(browser, workerInfo, 'user2');
const page = await context.newPage();
// Navigate to repo home page where code search is available
await page.goto('/user2/repo1');
await page.waitForLoadState('networkidle'); // eslint-disable-line playwright/no-networkidle
// The code search input is in the sidebar
const codeSearchInput = page.locator('.code-search-input');
await expect(codeSearchInput).toBeVisible();
// Verify the keyboard hint is visible
const kbdHint = page.locator('.repo-code-search-input-wrapper .repo-search-shortcut-hint');
await expect(kbdHint).toBeVisible();
await expect(kbdHint).toHaveText('S');
// Press S key to focus the code search input
await page.keyboard.press('s');
// Verify the input is focused
await expect(codeSearchInput).toBeFocused();
});
test('File search keyboard hint hides when input has value', async ({browser}, workerInfo) => {
const context = await load_logged_in_context(browser, workerInfo, 'user2');
const page = await context.newPage();
// Navigate to a repository page
await page.goto('/user2/repo1');
await page.waitForLoadState('networkidle'); // eslint-disable-line playwright/no-networkidle
// Check file search kbd hint
const fileSearchInput = page.locator('.repo-file-search-container input');
const fileKbdHint = page.locator('.repo-file-search-input-wrapper kbd');
// Initially the hint should be visible
await expect(fileKbdHint).toBeVisible();
// Focus and type in the file search
await fileSearchInput.click();
await page.keyboard.type('test');
// The hint should now be hidden (Vue component handles this with v-show)
await expect(fileKbdHint).toBeHidden();
});
test('Code search keyboard hint hides when input has value', async ({browser}, workerInfo) => {
const context = await load_logged_in_context(browser, workerInfo, 'user2');
const page = await context.newPage();
// Navigate to a repository page
await page.goto('/user2/repo1');
await page.waitForLoadState('networkidle'); // eslint-disable-line playwright/no-networkidle
const codeSearchInput = page.locator('.code-search-input');
await expect(codeSearchInput).toBeVisible();
const codeKbdHint = page.locator('.repo-code-search-input-wrapper .repo-search-shortcut-hint');
// Initially the hint should be visible
await expect(codeKbdHint).toBeVisible();
// Focus and type in the code search
await codeSearchInput.click();
await page.keyboard.type('search');
// The hint should now be hidden
await expect(codeKbdHint).toBeHidden();
});
test('Shortcuts do not trigger with modifier keys', async ({browser}, workerInfo) => {
const context = await load_logged_in_context(browser, workerInfo, 'user2');
const page = await context.newPage();
// Navigate to a repository page
await page.goto('/user2/repo1');
await page.waitForLoadState('networkidle'); // eslint-disable-line playwright/no-networkidle
const fileSearchInput = page.locator('.repo-file-search-container input');
// Click somewhere else first to ensure nothing is focused
await page.locator('body').click();
// Press Ctrl+T (should not focus file search - this is typically "new tab" in browsers)
await page.keyboard.press('Control+t');
// The file search input should NOT be focused
await expect(fileSearchInput).not.toBeFocused();
});
});