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
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- 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.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Extending IFiltersProps on a filterable list