StoresynkCollectionProps

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:22

Server-rendered wrapper (the filterable, server-driven listing). The children are the region exactly as the client engine expects it (filter controls + a product-list whose first child is the card template); the server fills the requested view - grid clones with per-card payloads, facet values with active states, chips, result count - embeds the listing payload, and marks the host ss-adopt so the client engine adopts the state instead of refetching.

Pass state (parseListingParams over the route’s searchParams) to server-render FILTERED/sorted/paged shared links too - the engine adopts any state that matches its own URL read. Without state, the default view is rendered and URL-carried state hydrates by fetching.

Falls back to plain client-side rendering when the fetch fails or the region has no usable product-list template. Children must be static host elements (see StoresynkProduct).

Properties

allHandle?

optional allHandle?: string

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:26

When handle is omitted: query this real collection instead of the catalog search.

children

children: ReactNode

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:47

className?

optional className?: string

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:46

fresh?

optional fresh?: boolean

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:45

Bypass the persistent cache and fetch live, deduped per request (see StoresynkList).

handle?

optional handle?: string

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:24

Collection handle. Omit for the whole catalog (the engine’s catalog mode).

infinite?

optional infinite?: boolean

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:33

Auto-load the next page near the bottom instead of a click.

locale?

optional locale?: I18nState | null

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:43

Per-request buyer market (from getRequestLocale()); null-safe.

noUrlSync?

optional noUrlSync?: boolean

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:34

pageSize?

optional pageSize?: number

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:28

Products per page (the engine’s page-size).

revalidate?

optional revalidate?: boolean

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:41

After adopting, silently re-check the listing in the background and repaint only on drift - the freshness backstop for long-lived cached renders (same contract as StoresynkProduct’s revalidate).

reverse?

optional reverse?: boolean

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:31

sortKey?

optional sortKey?: string

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:30

Initial sort (sort-key), e.g. “PRICE”; catalog mode only supports RELEVANCE/PRICE.

state?

optional state?: ListingSearchState | null

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:37

The route’s listing URL state (filters/sort/page), from parseListingParams.

urlKey?

optional urlKey?: string

Defined in: @storesynk/next/dist/components/StoresynkCollection.d.ts:35