@foxpixel/react 0.2.1 → 0.2.3

package/dist/index.d.mts

@@ -22,6 +22,10 @@ interface FoxPixelConfig {
      * Tenant ID (optional, can be set per request)
      */
     tenantId?: string;
+    /**
+     * Current locale for site content i18n (e.g. "en", "pt"). Omit for default.
+     */
+    locale?: string;
 }
 interface Service {
     id: string;
@@ -140,6 +144,8 @@ interface FoxPixelContextValue {
     config: FoxPixelConfig;
     /** Optional: pass QueryClient so edit-mode messaging can invalidate cache without requiring useQueryClient() in SDK (avoids "No QueryClient set" in iframe). */
     queryClient?: QueryClient | null;
+    /** Current locale for site content i18n (e.g. "en", "pt"). From config.locale. */
+    locale?: string;
 }
 interface FoxPixelProviderProps {
     children: ReactNode;
@@ -274,8 +280,10 @@ interface EditableProps {
     as?: keyof JSX.IntrinsicElements;
     multiline?: boolean;
     className?: string;
+    /** Override locale for this editable (default: from FoxPixelProvider config.locale). */
+    locale?: string;
 }
-declare function Editable({ contentKey, defaultValue, as, multiline, className, }: EditableProps): React.ReactElement<{
+declare function Editable({ contentKey, defaultValue, as, multiline, className, locale: localeProp, }: EditableProps): React.ReactElement<{
     className: string;
     'aria-busy': boolean;
     'aria-label': string;
@@ -291,7 +299,7 @@ declare function Editable({ contentKey, defaultValue, as, multiline, className,
 /**
  * Renders rich HTML content from the CMS. Content is sanitized before rendering.
  */
-declare function EditableHTML({ contentKey, defaultValue, as, className, }: Omit<EditableProps, 'multiline'>): React.ReactElement<{
+declare function EditableHTML({ contentKey, defaultValue, as, className, locale: localeProp, }: Omit<EditableProps, 'multiline'>): React.ReactElement<{
     className: string;
     'aria-busy': boolean;
 }, string | React.JSXElementConstructor<any>> | React.DetailedReactHTMLElement<{
@@ -311,11 +319,12 @@ interface EditableImageProps {
     width?: number;
     height?: number;
     priority?: boolean;
+    locale?: string;
 }
 /**
  * Renders an image from a CMS-managed URL. Uses native img (no Next.js Image in SDK).
  */
-declare function EditableImage({ contentKey, defaultValue, alt, className, width, height, priority, }: EditableImageProps): react_jsx_runtime.JSX.Element;
+declare function EditableImage({ contentKey, defaultValue, alt, className, width, height, priority, locale: localeProp, }: EditableImageProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Hook to fetch and manage services (Projects module)
@@ -470,6 +479,7 @@ declare function useContactCapture(): UseContactCaptureReturn;
 interface SiteContent {
     id: string;
     contentKey: string;
+    locale?: string;
     value: string | null;
     contentType: string;
     defaultValue: string | null;
@@ -488,6 +498,10 @@ interface UseSiteContentOptions {
      * Whether to fetch on mount (default: true)
      */
     fetchOnMount?: boolean;
+    /**
+     * Locale for i18n (e.g. "en", "pt"). Omit for default.
+     */
+    locale?: string;
 }
 interface UseSiteContentReturn {
     /**
@@ -561,6 +575,10 @@ interface UseSiteContentsOptions {
      * Default values map
      */
     defaults?: Record<string, string>;
+    /**
+     * Locale for i18n (e.g. "en", "pt"). Omit for default.
+     */
+    locale?: string;
 }
 interface UseSiteContentsReturn {
     /**
@@ -647,7 +665,10 @@ interface UseSiteContentSectionReturn {
  * }
  * ```
  */
-declare function useSiteContentSection(section: string): UseSiteContentSectionReturn;
+interface UseSiteContentSectionOptions {
+    locale?: string;
+}
+declare function useSiteContentSection(section: string, options?: UseSiteContentSectionOptions): UseSiteContentSectionReturn;
 
 /**
  * Edit-mode hooks for CMS Visual (iframe communication with Tenant Admin).
@@ -671,7 +692,7 @@ declare function useEditModeMessaging(): boolean;
  * Returns a callback to send an edit request to the parent iframe.
  * Only has effect when in edit mode.
  */
-declare function useSendEditRequest(): (contentKey: string, currentValue: string, contentType?: string, section?: string, description?: string) => void;
+declare function useSendEditRequest(): (contentKey: string, currentValue: string, contentType?: string, section?: string, description?: string, locale?: string) => void;
 
 /**
  * Site content hook for Editable components.
@@ -680,6 +701,8 @@ declare function useSendEditRequest(): (contentKey: string, currentValue: string
  */
 interface UseSiteContentQueryOptions {
     defaultValue: string;
+    /** Locale for i18n (e.g. "en", "pt"). Omit for default. */
+    locale?: string;
 }
 interface UseSiteContentQueryReturn {
     value: string;
@@ -702,6 +725,8 @@ interface PrefetchSiteContentOptions {
     apiKey?: string;
     tenantId?: string;
     contentKeys: string[];
+    /** Locale for i18n (e.g. "en", "pt"). Can pass multiple to prefetch several locales. */
+    locale?: string | string[];
 }
 /**
  * Prefetch site content keys and set them on the given QueryClient.

package/dist/index.d.ts

@@ -22,6 +22,10 @@ interface FoxPixelConfig {
      * Tenant ID (optional, can be set per request)
      */
     tenantId?: string;
+    /**
+     * Current locale for site content i18n (e.g. "en", "pt"). Omit for default.
+     */
+    locale?: string;
 }
 interface Service {
     id: string;
@@ -140,6 +144,8 @@ interface FoxPixelContextValue {
     config: FoxPixelConfig;
     /** Optional: pass QueryClient so edit-mode messaging can invalidate cache without requiring useQueryClient() in SDK (avoids "No QueryClient set" in iframe). */
     queryClient?: QueryClient | null;
+    /** Current locale for site content i18n (e.g. "en", "pt"). From config.locale. */
+    locale?: string;
 }
 interface FoxPixelProviderProps {
     children: ReactNode;
@@ -274,8 +280,10 @@ interface EditableProps {
     as?: keyof JSX.IntrinsicElements;
     multiline?: boolean;
     className?: string;
+    /** Override locale for this editable (default: from FoxPixelProvider config.locale). */
+    locale?: string;
 }
-declare function Editable({ contentKey, defaultValue, as, multiline, className, }: EditableProps): React.ReactElement<{
+declare function Editable({ contentKey, defaultValue, as, multiline, className, locale: localeProp, }: EditableProps): React.ReactElement<{
     className: string;
     'aria-busy': boolean;
     'aria-label': string;
@@ -291,7 +299,7 @@ declare function Editable({ contentKey, defaultValue, as, multiline, className,
 /**
  * Renders rich HTML content from the CMS. Content is sanitized before rendering.
  */
-declare function EditableHTML({ contentKey, defaultValue, as, className, }: Omit<EditableProps, 'multiline'>): React.ReactElement<{
+declare function EditableHTML({ contentKey, defaultValue, as, className, locale: localeProp, }: Omit<EditableProps, 'multiline'>): React.ReactElement<{
     className: string;
     'aria-busy': boolean;
 }, string | React.JSXElementConstructor<any>> | React.DetailedReactHTMLElement<{
@@ -311,11 +319,12 @@ interface EditableImageProps {
     width?: number;
     height?: number;
     priority?: boolean;
+    locale?: string;
 }
 /**
  * Renders an image from a CMS-managed URL. Uses native img (no Next.js Image in SDK).
  */
-declare function EditableImage({ contentKey, defaultValue, alt, className, width, height, priority, }: EditableImageProps): react_jsx_runtime.JSX.Element;
+declare function EditableImage({ contentKey, defaultValue, alt, className, width, height, priority, locale: localeProp, }: EditableImageProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Hook to fetch and manage services (Projects module)
@@ -470,6 +479,7 @@ declare function useContactCapture(): UseContactCaptureReturn;
 interface SiteContent {
     id: string;
     contentKey: string;
+    locale?: string;
     value: string | null;
     contentType: string;
     defaultValue: string | null;
@@ -488,6 +498,10 @@ interface UseSiteContentOptions {
      * Whether to fetch on mount (default: true)
      */
     fetchOnMount?: boolean;
+    /**
+     * Locale for i18n (e.g. "en", "pt"). Omit for default.
+     */
+    locale?: string;
 }
 interface UseSiteContentReturn {
     /**
@@ -561,6 +575,10 @@ interface UseSiteContentsOptions {
      * Default values map
      */
     defaults?: Record<string, string>;
+    /**
+     * Locale for i18n (e.g. "en", "pt"). Omit for default.
+     */
+    locale?: string;
 }
 interface UseSiteContentsReturn {
     /**
@@ -647,7 +665,10 @@ interface UseSiteContentSectionReturn {
  * }
  * ```
  */
-declare function useSiteContentSection(section: string): UseSiteContentSectionReturn;
+interface UseSiteContentSectionOptions {
+    locale?: string;
+}
+declare function useSiteContentSection(section: string, options?: UseSiteContentSectionOptions): UseSiteContentSectionReturn;
 
 /**
  * Edit-mode hooks for CMS Visual (iframe communication with Tenant Admin).
@@ -671,7 +692,7 @@ declare function useEditModeMessaging(): boolean;
  * Returns a callback to send an edit request to the parent iframe.
  * Only has effect when in edit mode.
  */
-declare function useSendEditRequest(): (contentKey: string, currentValue: string, contentType?: string, section?: string, description?: string) => void;
+declare function useSendEditRequest(): (contentKey: string, currentValue: string, contentType?: string, section?: string, description?: string, locale?: string) => void;
 
 /**
  * Site content hook for Editable components.
@@ -680,6 +701,8 @@ declare function useSendEditRequest(): (contentKey: string, currentValue: string
  */
 interface UseSiteContentQueryOptions {
     defaultValue: string;
+    /** Locale for i18n (e.g. "en", "pt"). Omit for default. */
+    locale?: string;
 }
 interface UseSiteContentQueryReturn {
     value: string;
@@ -702,6 +725,8 @@ interface PrefetchSiteContentOptions {
     apiKey?: string;
     tenantId?: string;
     contentKeys: string[];
+    /** Locale for i18n (e.g. "en", "pt"). Can pass multiple to prefetch several locales. */
+    locale?: string | string[];
 }
 /**
  * Prefetch site content keys and set them on the given QueryClient.