Skip to content

feat(DataViewTextFilter): use chipTitle prop for filter chip category #633

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
raswonders wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(DataViewTextFilter): use chipTitle prop for filter chip category #633

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
12 changes: 11 additions & 1 deletion 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,4 @@
import { render } from '@testing-library/react';
import { render, screen } from '@testing-library/react';
import '@testing-library/jest-dom';
import DataViewTextFilter, { DataViewTextFilterProps } from './DataViewTextFilter';
import DataViewToolbar from '../DataViewToolbar';
Expand All @@ -22,6 +22,16 @@ describe('DataViewTextFilter component', () => {
expect(container).toMatchSnapshot();
});

it('should use chipTitle for the filter chip category when provided', () => {
render(<DataViewToolbar
filters={
<DataViewTextFilter {...defaultProps} chipTitle="Short name" />
}
/>);
expect(screen.getByText('Short name')).toBeInTheDocument();
expect(screen.getByPlaceholderText('Filter by Test Filter')).toBeInTheDocument();
});

it('should focus the search input when "/" key is pressed and filter is visible', () => {
render(<DataViewToolbar
filters={
Expand Down
9 changes: 7 additions & 2 deletions packages/module/src/DataViewTextFilter/DataViewTextFilter.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ export interface DataViewTextFilterProps extends SearchInputProps {
value?: string;
/** Filter title displayed in the toolbar */
title: string;
/** Label for the applied filter chip / category; defaults to title */
chipTitle?: string;
/** Callback for when the input value changes */
onChange?: (event: React.FormEvent<HTMLInputElement> | undefined, value: string) => void;
/** Controls visibility of the filter in the toolbar */
Expand All @@ -24,6 +26,7 @@ export interface DataViewTextFilterProps extends SearchInputProps {
export const DataViewTextFilter: FC<DataViewTextFilterProps> = ({
filterId,
title,
chipTitle,
value = '',
onChange,
onClear = () => onChange?.(undefined, ''),
Expand All @@ -33,6 +36,8 @@ export const DataViewTextFilter: FC<DataViewTextFilterProps> = ({
enableShortcut = true,
...props
}: DataViewTextFilterProps) => {
const categoryName = chipTitle ?? title;

useEffect(() => {
if (!enableShortcut) {
return;
Expand Down Expand Up @@ -68,9 +73,9 @@ export const DataViewTextFilter: FC<DataViewTextFilterProps> = ({
<ToolbarFilter
key={ouiaId}
data-ouia-component-id={ouiaId}
labels={value.length > 0 ? [ { key: title, node: value } ] : []}
labels={value.length > 0 ? [ { key: categoryName, node: value } ] : []}
deleteLabel={() => onChange?.(undefined, '')}
categoryName={title}
categoryName={categoryName}
showToolbarItem={showToolbarItem}
>
<SearchInput
Expand Down
Loading