FilterForm

<FilterForm> renders list filters as a form connected to the current list context.

Installation

pnpm dlx shadcn@latest add @shadmin/filter-form

Usage

import { FilterForm } from "@/components/admin";
 
<FilterForm filters={[<TextInput source="q" alwaysOn />]} />;

Before: teams had to infer this component from surrounding CRUD examples.

After: the component has a direct import example and a focused behavior note.

Props

PropRequiredTypeDefaultDescription
filtersOptionalReactNode[][]Filter inputs to render.

Behavior

Use this component inside the matching ra-core context. For example, list helpers belong inside a list, form helpers belong inside a form, and show-layout helpers belong inside a show view.