Files
firecms/website/docs/api/interfaces/collectionfetchprops.md
2021-06-06 13:36:47 +02:00

1.9 KiB

id, title, sidebar_label, sidebar_position, custom_edit_url
id title sidebar_label sidebar_position custom_edit_url
collectionfetchprops Interface: CollectionFetchProps<S, Key> CollectionFetchProps 0 null

Type parameters

Name Type
S S: EntitySchema<Key>
Key Key: string

Properties

collectionPath

collectionPath: string

Absolute collection path

Defined in

hooks/useCollectionFetch.tsx:16


currentSort

Optional currentSort: Order

Defined in

hooks/useCollectionFetch.tsx:36


entitiesDisplayedFirst

Optional entitiesDisplayedFirst: Entity<S, Key>[]

List of entities that will be displayed on top, no matter the ordering. This is used for reference fields selection

Defined in

hooks/useCollectionFetch.tsx:30


filter

Optional filter: Partial<{ [K in string]: [WhereFilterOp, any]}>

Defined in

hooks/useCollectionFetch.tsx:32


itemCount

Optional itemCount: number

Defined in

hooks/useCollectionFetch.tsx:24


schema

schema: S

Schema of the entity displayed by this collection

Defined in

hooks/useCollectionFetch.tsx:21


sortByProperty

Optional sortByProperty: string

Defined in

hooks/useCollectionFetch.tsx:34