BuildListViewSearchQueryArgsProps
Defined in: packages/core/src/collections/listView/listViewQueryArgs.ts:78
Props for buildListViewSearchQueryArgs.
Extends
Section titled “Extends”BuildListViewQueryArgsBaseProps<TFieldSlug>
Type Parameters
Section titled “Type Parameters”TFieldSlug
Section titled “TFieldSlug”TFieldSlug extends string = string
Properties
Section titled “Properties”collection
Section titled “collection”collection:
CollectionConfig<{ }, { },string,Record<string,AdminField>,ComponentHKT,boolean,boolean,string> |MediaCollectionConfig
Defined in: packages/core/src/collections/listView/listViewQueryArgs.ts:28
The resolved collection (or media collection) config — same object useVexListQuery and NextAdminPage both already hold.
Inherited from
Section titled “Inherited from”BuildListViewQueryArgsBaseProps.collection
cursor?
Section titled “cursor?”
optionalcursor?:string|null
Defined in: packages/core/src/collections/listView/listViewQueryArgs.ts:43
Load More’s cursor. undefined/omitted means the first page — every server prefetch reads one.
Inherited from
Section titled “Inherited from”BuildListViewQueryArgsBaseProps.cursor
drafts?
Section titled “drafts?”
optionaldrafts?:boolean
Defined in: packages/core/src/collections/listView/listViewQueryArgs.ts:32
Include draft versions of versioned documents.
Inherited from
Section titled “Inherited from”BuildListViewQueryArgsBaseProps.drafts
numItems
Section titled “numItems”numItems:
number
Defined in: packages/core/src/collections/listView/listViewQueryArgs.ts:41
Documents to fetch this round-trip — already Math.max(collection.admin.view.state.serverPageSize, pageSize) (Step 8’s “the server batch always covers at least one client page” rule).
That Math.max stays at each CALLER’s own site, beside the pageSize/size value it
reads, rather than moving in here — useVexListQuery and NextAdminPage read
pageSize from two different places (a hook prop vs. resolveListViewQueryState’s
output), so there is no single shared pageSize input to compute it from.
Inherited from
Section titled “Inherited from”BuildListViewQueryArgsBaseProps.numItems
search
Section titled “search”search:
string
Defined in: packages/core/src/collections/listView/listViewQueryArgs.ts:81
Raw search text. Never empty — the caller branches to buildListViewFindQueryArgs instead when it is.
searchField
Section titled “searchField”searchField:
TFieldSlug
Defined in: packages/core/src/collections/listView/listViewQueryArgs.ts:83
Which admin.view.state.searchFields entry search queries — validateSavedListViewConfig (Design Decision 3) guarantees it has a declared searchIndex.
where?
Section titled “where?”
optionalwhere?:VexWhere<TFieldSlug>
Defined in: packages/core/src/collections/listView/listViewQueryArgs.ts:30
Predicate over the collection’s fields: a builder callback or an already-plain node.
Inherited from
Section titled “Inherited from”BuildListViewQueryArgsBaseProps.where