Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion apps/www/src/content/docs/dataview/props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ export interface DataViewField {
/** Filter input type. */
filterType?: 'string' | 'number' | 'date' | 'select' | 'multiselect';

/** Options when filterType is select/multiselect. */
/** Options when filterType is select/multiselect. The add-filter menu leaves out the field while this is empty, and the trigger is disabled if no other field is available. */
filterOptions?: Array<{ label: string; value: string }>;

/** Allow sorting. */
Expand Down
66 changes: 66 additions & 0 deletions packages/react/components/data-view/__tests__/data-view.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,72 @@ describe('DataView', () => {
).toBeInTheDocument();
});

it('does not offer select or multiselect fields without filterOptions', async () => {
const user = userEvent.setup();
const fields: DataViewField<TestData>[] = [
{ accessorKey: 'name', label: 'Name', filterable: true },
{
accessorKey: 'status',
label: 'Status',
filterable: true,
filterType: 'select',
filterOptions: [{ label: 'Active', value: 'string' }]
},
{
accessorKey: 'email',
label: 'Email',
filterable: true,
filterType: 'select',
filterOptions: []
},
{
accessorKey: 'id',
label: 'Id',
filterable: true,
filterType: 'multiselect'
}
];
render(
<DataView data={mockData} fields={fields} defaultSort={defaultSort}>
<DataView.Filters
trigger={({ availableFilters }) => (
<button type='button'>
{availableFilters.map(f => f.label).join(',')}
</button>
)}
/>
</DataView>
);
const trigger = screen.getByRole('button');
expect(trigger).toHaveTextContent(/^Name,Status$/);
await user.click(trigger);
await screen.findByRole('menuitem', { name: 'Status' });
expect(screen.getAllByRole('menuitem').map(i => i.textContent)).toEqual([
'Name',
'Status'
]);
});

it('disables the filter trigger while select options are loading', () => {
render(
<DataView
data={mockData}
fields={[
{
accessorKey: 'name',
label: 'Name',
filterable: true,
filterType: 'select'
}
]}
defaultSort={defaultSort}
>
<DataView.Filters />
</DataView>
);
expect(screen.getByRole('button', { name: /filter/i })).toBeDisabled();
});

it('search input updates the query', async () => {
const user = userEvent.setup();
render(
Expand Down
11 changes: 9 additions & 2 deletions packages/react/components/data-view/components/filters.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,15 @@ function AddFilter<TData>({
className,
...positionerProps
}: AddFilterProps<TData>) {
const availableFilters = fieldList?.filter(
const unappliedFields = fieldList.filter(
f => !appliedFiltersSet.has(f.accessorKey)
);
const availableFilters = unappliedFields.filter(
f =>
f.filterOptions?.length ||
Comment thread
rohilsurana marked this conversation as resolved.
(f.filterType !== FilterType.select &&
f.filterType !== FilterType.multiselect)
);

const trigger = useMemo(() => {
if (typeof children === 'function')
Expand Down Expand Up @@ -75,9 +81,10 @@ function AddFilter<TData>({
);
}, [children, appliedFiltersSet, availableFilters, className]);

return availableFilters.length > 0 ? (
return unappliedFields.length > 0 ? (
<Menu>
<Menu.Trigger
disabled={availableFilters.length === 0}
render={isValidElement(trigger) ? trigger : <button>{trigger}</button>}
/>
<Menu.Content {...positionerProps}>
Expand Down
Loading