Skip to content

RenderListOptions

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

  • BaseRenderOptions

optional allProducts?: boolean

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

Render every product in the store instead of a collection (collection wins).


optional collection?: string

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

Collection handle to render. Omit and set allProducts for the whole catalog.


optional fresh?: boolean

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

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

BaseRenderOptions.fresh


optional limit?: number

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


optional locale?: I18nState | null

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

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

RenderListOptions.locale


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.

RenderListOptions.request


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.

BaseRenderOptions.scope