RenderCollectionOptions

Defined in: @storesynk/react/dist/render.d.ts:101

Extends

• BaseRenderOptions

Properties

allHandle?

optional allHandle?: string

Defined in: @storesynk/react/dist/render.d.ts:105

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

---

fresh?

optional fresh?: boolean

Defined in: @storesynk/react/dist/runtime.d.ts:27

Bypass the module cache and fetch live (per-request SSR freshness).

Inherited from

BaseRenderOptions.fresh

---

handle?

optional handle?: string

Defined in: @storesynk/react/dist/render.d.ts:103

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

---

infinite?

optional infinite?: boolean

Defined in: @storesynk/react/dist/render.d.ts:112

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

---

locale?

optional locale?: I18nState | null

Defined in: @storesynk/react/dist/render.d.ts:17

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

Inherited from

RenderListOptions.locale

---

noUrlSync?

optional noUrlSync?: boolean

Defined in: @storesynk/react/dist/render.d.ts:113

---

pageSize?

optional pageSize?: number

Defined in: @storesynk/react/dist/render.d.ts:107

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

---

request?

optional request?: string | Request | URL | null

Defined in: @storesynk/react/dist/render.d.ts:27

The incoming request (or its URL) - pass it and each helper derives its per-request inputs itself: locale from the buyer’s locale cookie (Request source only), renderCollection’s state and renderProduct’s selectedOptions from the URL’s search params, renderProductJsonLd’s canonical url from origin + pathname. Explicit options always win. Frameworks pass what they have - the Request (Remix loader arg, TanStack getWebRequest()) or the page URL. Null-safe.

Inherited from

RenderListOptions.request

---

revalidate?

optional revalidate?: boolean

Defined in: @storesynk/react/dist/render.d.ts:123

After adopting, silently re-check the listing in the background and repaint only on drift (same contract as renderProduct’s revalidate).

---

reverse?

optional reverse?: boolean

Defined in: @storesynk/react/dist/render.d.ts:110

---

scope?

optional scope?: RequestScope

Defined in: @storesynk/react/dist/runtime.d.ts:30

With fresh: dedupe fetches within one request (see createRequestScope). Without it, every fresh call fetches.

Inherited from

BaseRenderOptions.scope

---

sortKey?

optional sortKey?: string

Defined in: @storesynk/react/dist/render.d.ts:109

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

---

state?

optional state?: ListingSearchState | null

Defined in: @storesynk/react/dist/render.d.ts:120

The route’s listing URL state (filters/sort/page), from parseListingParams over the request’s search params - server-renders FILTERED/sorted/paged shared links too; the engine adopts any state matching its own URL read. Derived automatically from request (a bare URL ≡ the default view); pass explicitly only to override, or null to force the default view.

---

urlKey?

optional urlKey?: string

Defined in: @storesynk/react/dist/render.d.ts:114