Skip to content

fix: handle keyboard shortcut for text filter #594

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

Merged
nicolethoen merged 2 commits into from
Feb 5, 2026
Merged

fix: handle keyboard shortcut for text filter #594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5db6ac1
fix: handle keyboard shortcut for text filter
CodyWMitchell Jan 26, 2026
7aa56a1
fix: add prop to disable keyboard shortcut
CodyWMitchell Feb 4, 2026
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
129 changes: 129 additions & 0 deletions packages/module/src/DataViewTextFilter/DataViewTextFilter.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { render } from '@testing-library/react';
import '@testing-library/jest-dom';
import DataViewTextFilter, { DataViewTextFilterProps } from './DataViewTextFilter';
import DataViewToolbar from '../DataViewToolbar';

Expand All @@ -20,4 +21,132 @@ describe('DataViewTextFilter component', () => {
/>);
expect(container).toMatchSnapshot();
});

it('should focus the search input when "/" key is pressed and filter is visible', () => {
render(<DataViewToolbar
filters={
<DataViewTextFilter {...defaultProps} showToolbarItem={true} />
}
/>);

const input = document.getElementById('test-filter') as HTMLInputElement;
expect(input).toBeInTheDocument();

// Simulate pressing "/" key by creating and dispatching a KeyboardEvent
const keyEvent = new KeyboardEvent('keydown', {
key: '/',
code: 'Slash',
bubbles: true,
cancelable: true,
});
window.dispatchEvent(keyEvent);

// Check that the input has focus
expect(document.activeElement).toBe(input);
});

it('should not focus the search input when "/" key is pressed if filter is not visible', () => {
render(<DataViewToolbar
filters={
<DataViewTextFilter {...defaultProps} showToolbarItem={false} />
}
/>);

const input = document.getElementById('test-filter') as HTMLInputElement;

// Simulate pressing "/" key
const keyEvent = new KeyboardEvent('keydown', {
key: '/',
code: 'Slash',
bubbles: true,
cancelable: true,
});
window.dispatchEvent(keyEvent);

if (input) {
expect(document.activeElement).not.toBe(input);
}
});

it('should not focus the search input when "/" key is pressed while typing in another input', () => {
const { container } = render(
<div>
<input data-testid="other-input" />
<DataViewToolbar
filters={
<DataViewTextFilter {...defaultProps} showToolbarItem={true} />
}
/>
</div>
);

const otherInput = container.querySelector('[data-testid="other-input"]') as HTMLInputElement;

// Focus the other input first
otherInput.focus();
expect(document.activeElement).toBe(otherInput);

// Simulate pressing "/" key while focused on the other input
// The event target should be the input element
const keyEvent = new KeyboardEvent('keydown', {
key: '/',
code: 'Slash',
bubbles: true,
cancelable: true,
});
Object.defineProperty(keyEvent, 'target', {
value: otherInput,
enumerable: true,
});
window.dispatchEvent(keyEvent);

// The search input should not be focused since we're already in an input field
expect(document.activeElement).toBe(otherInput);
});

it('should not focus the search input when enableShortcut is false', () => {
render(<DataViewToolbar
filters={
<DataViewTextFilter {...defaultProps} showToolbarItem={true} enableShortcut={false} />
}
/>);

const input = document.getElementById('test-filter') as HTMLInputElement;
expect(input).toBeInTheDocument();

// Simulate pressing "/" key
const keyEvent = new KeyboardEvent('keydown', {
key: '/',
code: 'Slash',
bubbles: true,
cancelable: true,
});
window.dispatchEvent(keyEvent);

// The input should not be focused since the shortcut is disabled
expect(document.activeElement).not.toBe(input);
});

it('should focus the search input when enableShortcut is true (default)', () => {
render(<DataViewToolbar
filters={
<DataViewTextFilter {...defaultProps} showToolbarItem={true} />
}
/>);

const input = document.getElementById('test-filter') as HTMLInputElement;
expect(input).toBeInTheDocument();

// Simulate pressing "/" key
const keyEvent = new KeyboardEvent('keydown', {
key: '/',
code: 'Slash',
bubbles: true,
cancelable: true,
});
window.dispatchEvent(keyEvent);

// The input should be focused since the shortcut is enabled by default
expect(document.activeElement).toBe(input);
});
});
80 changes: 58 additions & 22 deletions packages/module/src/DataViewTextFilter/DataViewTextFilter.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { FC } from 'react';
import { FC, useEffect } from 'react';
import { SearchInput, SearchInputProps, ToolbarFilter, ToolbarFilterProps } from '@patternfly/react-core';

/** extends SearchInputProps */
Expand All @@ -17,6 +17,8 @@ export interface DataViewTextFilterProps extends SearchInputProps {
trimValue?: boolean;
/** Custom OUIA ID */
ouiaId?: string;
/** Enable keyboard shortcut (/) to focus the filter. Defaults to true. */
enableShortcut?: boolean;
}

export const DataViewTextFilter: FC<DataViewTextFilterProps> = ({
Expand All @@ -28,27 +30,61 @@ export const DataViewTextFilter: FC<DataViewTextFilterProps> = ({
showToolbarItem,
trimValue = true,
ouiaId = 'DataViewTextFilter',
enableShortcut = true,
...props
}: DataViewTextFilterProps) => (
<ToolbarFilter
key={ouiaId}
data-ouia-component-id={ouiaId}
labels={value.length > 0 ? [ { key: title, node: value } ] : []}
deleteLabel={() => onChange?.(undefined, '')}
categoryName={title}
showToolbarItem={showToolbarItem}
>
<SearchInput
searchInputId={filterId}
value={value}
onChange={(e, inputValue) => onChange?.(e, trimValue ? inputValue.trim() : inputValue)}
onClear={onClear}
placeholder={`Filter by ${title}`}
aria-label={`${title ?? filterId} filter`}
data-ouia-component-id={`${ouiaId}-input`}
{...props}
/>
</ToolbarFilter>
);
}: DataViewTextFilterProps) => {
useEffect(() => {
if (!enableShortcut) {
return;
}

const handleKeyDown = (event: KeyboardEvent) => {
// Only handle "/" key when not typing in an input, textarea, or contenteditable element
if (event.key === '/' && !event.ctrlKey && !event.metaKey && !event.altKey) {
const target = event.target as HTMLElement;
const isInputElement = target.tagName === 'INPUT' ||
target.tagName === 'TEXTAREA' ||
target.isContentEditable;

// Only focus if the filter is visible and we're not already in an input field
if (showToolbarItem && !isInputElement) {
// Find the input element by its ID (searchInputId prop)
const inputElement = document.getElementById(filterId) as HTMLInputElement;
if (inputElement) {
event.preventDefault();
inputElement.focus();
}
}
}
};

window.addEventListener('keydown', handleKeyDown);
return () => {
window.removeEventListener('keydown', handleKeyDown);
};
}, [showToolbarItem, filterId, enableShortcut]);

return (
<ToolbarFilter
key={ouiaId}
data-ouia-component-id={ouiaId}
labels={value.length > 0 ? [ { key: title, node: value } ] : []}
deleteLabel={() => onChange?.(undefined, '')}
categoryName={title}
showToolbarItem={showToolbarItem}
>
<SearchInput
searchInputId={filterId}
value={value}
onChange={(e, inputValue) => onChange?.(e, trimValue ? inputValue.trim() : inputValue)}
onClear={onClear}
placeholder={`Filter by ${title}`}
aria-label={`${title ?? filterId} filter`}
data-ouia-component-id={`${ouiaId}-input`}
{...props}
/>
</ToolbarFilter>
);
};

export default DataViewTextFilter;
Loading