Skip to content

StoresynkStoreProps

Defined in: @storesynk/next/dist/components/StoresynkStore.d.ts:11

Server-rendered wrapper. Renders the store root with the configured credentials and embeds the shop (moneyFormat, currency) as a JSON payload, so the client runtime seeds shop state synchronously - money displayers format on their very first update. Children are ordinary React content (the store wraps whole pages); only / slots are server-transformed.

optional children?: any

Defined in: @storesynk/next/dist/components/StoresynkStore.d.ts:44


optional className?: string

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

Forwarded to the host (layout classes live there).


optional country?: string

Defined in: @storesynk/next/dist/components/StoresynkStore.d.ts:12


optional customer?: RestoredCustomerSession | null

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

Per-request restored customer session (from getRequestCustomer()) - stamps ss-logged-in so auth-gated CSS is right on first paint. Null passes through safely (logged-out render). NOTE: unlike the Astro wrapper (which runs renderCustomerChrome over its rendered slot), show-customer-* displayers OUTSIDE stay hydration-only here - React children can’t be string-transformed; inside product fragments they SSR as usual.


optional fresh?: boolean

Defined in: @storesynk/next/dist/components/StoresynkStore.d.ts:29

Bypass the persistent cache and fetch live (deduped per request) - for draft/preview reads that must reflect Shopify right now. The default cached path is webhook-invalidated (createStoresynkWebhookHandler), so most routes never need this.


optional language?: string

Defined in: @storesynk/next/dist/components/StoresynkStore.d.ts:13


optional loadRuntime?: boolean

Defined in: @storesynk/next/dist/components/StoresynkStore.d.ts:36

Render the elements-runtime loader (default true). Set false if you place yourself.


optional locale?: I18nState | null

Defined in: @storesynk/next/dist/components/StoresynkStore.d.ts:16

Per-request buyer market (from getRequestLocale()); wins over country/language and the config defaults. Null passes through safely.


optional persistLocale?: "localStorage" | "cookie" | "none"

Defined in: @storesynk/next/dist/components/StoresynkStore.d.ts:32

Locale persistence for the client store (‘cookie’ recommended alongside dynamic routes so the server can read the buyer’s market).


optional serverCart?: boolean

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

Server-owned cart: the cart id lives in an HttpOnly cookie and every mutation runs as a server action - the browser never learns the id. The standard actions/events protocol is unchanged. Default false (direct Storefront-API cart, localStorage id).


optional trackEvents?: boolean

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