Interface: CollectionFetchProps<M>
Type parameters​
Name | Type |
---|---|
M | extends Object |
Properties​
collection​
• collection: EntityCollection
<M
, string
, User
>
collection of the entity displayed by this collection
Defined in​
lib/src/hooks/data/useCollectionFetch.tsx:19
entitiesDisplayedFirst​
• Optional
entitiesDisplayedFirst: Entity
<M
>[]
List of entities that will be displayed on top, no matter the ordering. This is used for reference fields selection
Defined in​
lib/src/hooks/data/useCollectionFetch.tsx:30
filterValues​
• Optional
filterValues: Partial
<Record
<Extract
<keyof M
, string
>, [WhereFilterOp
, any
]>>
Filter the fetched data by the property
Defined in​
lib/src/hooks/data/useCollectionFetch.tsx:35
itemCount​
• Optional
itemCount: number
Number of entities to fetch
Defined in​
lib/src/hooks/data/useCollectionFetch.tsx:24
path​
• path: string
Absolute collection path
Defined in​
lib/src/hooks/data/useCollectionFetch.tsx:14
searchString​
• Optional
searchString: string
Search string
Defined in​
lib/src/hooks/data/useCollectionFetch.tsx:45
sortBy​
• Optional
sortBy: [Extract
<keyof M
, string
>, "asc"
| "desc"
]
Sort the results by