IFiltersProps
interface
Data & Filtering
Filter contract for list / autocomplete components — declares the full filtering surface: custom function, per-key function, targeted keys, filter mode and an escape hatch to bypass filtering entirely.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- customFilterTFilterFunction
- Global custom filter function applied to each item. Overrides the built-in matching logic when provided.
- customKeyFilterTFilterKeyFunctions
- Per-key custom filter functions — a map from item property name to a filter function, allowing different matching strategies per field.
- filterKeysTFilterKeys
- Which item properties to match against — a single key name, an array of key names, or a structured descriptor.
- filterModeTFilterMode
- How multiple filterKeys are combined: "every" (AND) | "some" (OR) | "union" | "intersection".
- noFilterboolean
- When true, filtering is skipped entirely and all items are returned as-is.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Extending IFiltersProps on a filterable list