react-bricks 4.6.0 → 4.7.0-alpha.0

package/react-bricks.d.ts

@@ -4,8 +4,8 @@ import { Descendant, Editor as Editor$1, BaseEditor, Element, Node } from 'slate
 import { RenderElementProps, RenderLeafProps, ReactEditor } from 'slate-react';
 import { HistoryEditor } from 'slate-history';
 import { Props } from 'react-inlinesvg';
-import * as react_query from 'react-query';
-import { UseQueryResult } from 'react-query';
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { UseQueryResult } from '@tanstack/react-query';
 export { v4 as uuid } from 'uuid';
 
 declare namespace types {
@@ -61,6 +61,7 @@ declare namespace types {
      * Supported Icon Sets
      */
     export enum IconSets {
+        Lucide = "lu",
         HeroIconSolid = "hi-solid",
         HeroIconOutline = "hi-outline",
         FontAwesome = "fa6",
@@ -393,7 +394,7 @@ declare namespace types {
         getDefaultProps?: () => Partial<T>;
         hideFromAddMenu?: boolean;
         sideEditProps?: Array<ISideEditProp<T> | ISideGroup<T>>;
-        repeaterItems?: IRepeaterItem[];
+        repeaterItems?: IRepeaterItem<T>[];
         newItemMenuOpen?: boolean;
         groupByRepeater?: boolean;
         mapExternalDataToProps?: (externalData: Props, brickProps?: T) => Partial<T>;
@@ -407,11 +408,30 @@ declare namespace types {
         previewImageUrl?: string;
         previewIcon?: React__default.ReactElement;
         stories?: BrickStory<Partial<T>>[];
+        astroInteractivity?: 'load' | {
+            load: true;
+        } | 'idle' | {
+            idle: true;
+        } | {
+            idle: {
+                timeout: number;
+            };
+        } | 'visible' | {
+            visible: true;
+        } | {
+            visible: {
+                rootMargin: string;
+            };
+        } | {
+            media: string;
+        } | {
+            only: string;
+        };
     }
     /**
      * Item of a Repeater
      */
-    export interface IRepeaterItem {
+    export interface IRepeaterItem<T = any> {
         name: string;
         label?: string;
         itemType?: string;
@@ -419,14 +439,15 @@ declare namespace types {
         defaultOpen?: boolean;
         min?: number;
         max?: number;
-        positionLabel?: string;
         getDefaultProps?: () => Props;
+        show?: (props: T, page?: Page, user?: User) => boolean;
         items?: {
             type: string;
             label?: string;
             min?: number;
             max?: number;
             getDefaultProps?: () => Props;
+            show?: (props: T, page?: Page, user?: User) => boolean;
         }[];
     }
     /**
@@ -444,9 +465,11 @@ declare namespace types {
     /**
      * Option of a select sidebar prop
      */
-    export interface IOption {
-        value: any;
+    export type RepeatserItems<T = RepeaterItemDefault> = Array<T>;
+    export interface IOption<T = any> {
+        value: T;
         label: string;
+        [otherProps: string]: unknown;
     }
     /**
      * Interface for Props of a Custom sidebar component
@@ -704,6 +727,7 @@ declare namespace types {
         permissions?: Permissions;
         allowAccentsInSlugs?: boolean;
         warningIfLowBattery?: boolean;
+        rtlLanguages?: Array<string>;
     }
     /**
      * The ReactBricks context
@@ -754,6 +778,10 @@ declare namespace types {
         permissions?: Permissions;
         allowAccentsInSlugs: boolean;
         warningIfLowBattery: boolean;
+        isRtlLanguage: ({ language }: {
+            language: string;
+        }) => boolean;
+        rtlLanguages: string[];
     }
     /**
      * The current page in Admin
@@ -835,9 +863,9 @@ declare namespace types {
         itemName?: string;
         label: string;
         hotKey?: string;
-        renderElement?: (props: RenderElementProps) => JSX.Element;
-        renderItemElement?: (props: RenderElementProps) => JSX.Element;
-        renderLeaf?: (props: RenderLeafProps) => JSX.Element;
+        renderElement?: (props: RenderElementProps) => React__default.ReactElement;
+        renderItemElement?: (props: RenderElementProps) => React__default.ReactElement;
+        renderLeaf?: (props: RenderLeafProps) => React__default.ReactElement;
         toggle: (editor: Editor$1, plugins: RichTextPlugin[], showRichTextModal: types.ShowRichTextModal) => void;
         button?: {
             icon: React__default.ReactElement;
@@ -852,7 +880,7 @@ declare namespace types {
         name: string;
         label?: string;
         hotKey?: string;
-        render: (props: RenderLeafProps) => JSX.Element;
+        render: (props: RenderLeafProps) => React__default.ReactElement;
         icon?: React__default.ReactElement;
     }
     /**
@@ -868,14 +896,14 @@ declare namespace types {
         itemName?: string;
         label?: string;
         hotKey?: string;
-        render: (props: RenderElementProps) => JSX.Element;
-        renderItem?: (props: RenderElementProps) => JSX.Element;
+        render: (props: RenderElementProps) => React__default.ReactElement;
+        renderItem?: (props: RenderElementProps) => React__default.ReactElement;
         icon?: React__default.ReactElement;
     }
     export type BlockWithModalPlugin = BlockPlugin & {
         getDefaultProps?: () => Props;
-        renderAdmin?: (props: RenderElementProps) => JSX.Element;
-        renderItemAdmin?: (props: RenderElementProps) => JSX.Element;
+        renderAdmin?: (props: RenderElementProps) => React__default.ReactElement;
+        renderItemAdmin?: (props: RenderElementProps) => React__default.ReactElement;
         pluginCustomFields: Array<types.ISideEditPropPage | types.ISideGroup>;
     };
     /**
@@ -918,7 +946,7 @@ declare const Link: React.FC<LinkPropsReal>;
  */
 interface FileProps {
     propName: string;
-    renderBlock: (props: types.IFileSource | null) => JSX.Element;
+    renderBlock: (props: types.IFileSource | null) => React__default.ReactElement;
     allowedExtensions?: string[];
     /**
      * Field used with React Server Components
@@ -1008,31 +1036,31 @@ interface RenderLinkElementProps extends RenderElementProps {
     rel?: string;
 }
 interface BaseRichTextProps {
-    renderBlock?: (props: RenderElementProps) => JSX.Element;
+    renderBlock?: (props: RenderElementProps) => React__default.ReactElement;
     placeholder?: string;
     renderPlaceholder?: (props: {
         children: any;
-    }) => JSX.Element;
+    }) => React__default.ReactElement;
     multiline?: boolean;
     softLineBreak?: boolean;
     allowedFeatures?: types.RichTextFeatures[];
-    renderBold?: (props: RenderLeafProps) => JSX.Element;
-    renderItalic?: (props: RenderLeafProps) => JSX.Element;
-    renderHighlight?: (props: RenderLeafProps) => JSX.Element;
-    renderCode?: (props: RenderLeafProps) => JSX.Element;
-    renderSub?: (props: RenderLeafProps) => JSX.Element;
-    renderSup?: (props: RenderLeafProps) => JSX.Element;
-    renderLink?: (props: RenderLinkElementProps) => JSX.Element;
-    renderUL?: (props: RenderElementProps) => JSX.Element;
-    renderOL?: (props: RenderElementProps) => JSX.Element;
-    renderLI?: (props: RenderElementProps) => JSX.Element;
-    renderH1?: (props: RenderElementProps) => JSX.Element;
-    renderH2?: (props: RenderElementProps) => JSX.Element;
-    renderH3?: (props: RenderElementProps) => JSX.Element;
-    renderH4?: (props: RenderElementProps) => JSX.Element;
-    renderH5?: (props: RenderElementProps) => JSX.Element;
-    renderH6?: (props: RenderElementProps) => JSX.Element;
-    renderQuote?: (props: RenderElementProps) => JSX.Element;
+    renderBold?: (props: RenderLeafProps) => React__default.ReactElement;
+    renderItalic?: (props: RenderLeafProps) => React__default.ReactElement;
+    renderHighlight?: (props: RenderLeafProps) => React__default.ReactElement;
+    renderCode?: (props: RenderLeafProps) => React__default.ReactElement;
+    renderSub?: (props: RenderLeafProps) => React__default.ReactElement;
+    renderSup?: (props: RenderLeafProps) => React__default.ReactElement;
+    renderLink?: (props: RenderLinkElementProps) => React__default.ReactElement;
+    renderUL?: (props: RenderElementProps) => React__default.ReactElement;
+    renderOL?: (props: RenderElementProps) => React__default.ReactElement;
+    renderLI?: (props: RenderElementProps) => React__default.ReactElement;
+    renderH1?: (props: RenderElementProps) => React__default.ReactElement;
+    renderH2?: (props: RenderElementProps) => React__default.ReactElement;
+    renderH3?: (props: RenderElementProps) => React__default.ReactElement;
+    renderH4?: (props: RenderElementProps) => React__default.ReactElement;
+    renderH5?: (props: RenderElementProps) => React__default.ReactElement;
+    renderH6?: (props: RenderElementProps) => React__default.ReactElement;
+    renderQuote?: (props: RenderElementProps) => React__default.ReactElement;
 }
 interface RichTextPropsWithPropName extends BaseRichTextProps {
     propName: string;
@@ -1068,11 +1096,11 @@ declare const CompatibleRichText: React__default.FC<RichTextProps$1>;
  * Props for RichTextExt (v3)
  */
 interface RichTextProps {
-    renderBlock?: (props: RenderElementProps) => JSX.Element;
+    renderBlock?: (props: RenderElementProps) => React.ReactElement;
     placeholder?: string;
     renderPlaceholder?: (props: {
         children: any;
-    }) => JSX.Element;
+    }) => React.ReactElement;
     plugins?: types.RichTextPlugin[];
     multiline?: boolean;
     softLineBreak?: boolean;
@@ -1111,11 +1139,11 @@ declare module 'slate' {
     }
 }
 interface BaseTextProps {
-    renderBlock?: (props: RenderElementProps) => JSX.Element;
+    renderBlock?: (props: RenderElementProps) => React.ReactElement;
     placeholder?: string;
     renderPlaceholder?: (props: {
         children: any;
-    }) => JSX.Element;
+    }) => React.ReactElement;
     multiline?: boolean;
     softLineBreak?: boolean;
 }
@@ -1193,9 +1221,9 @@ declare const Meta: React.FC<MetaProps>;
 
 declare const renderMeta: React.FC<types.Page>;
 
-declare const usePage$1: (pageId: string, language?: string) => react_query.UseQueryResult<types.Page, unknown>;
+declare const usePage$1: (pageId: string, language?: string) => _tanstack_react_query.UseQueryResult<types.Page, Error>;
 
-declare const usePage: (slug: string, language?: string) => react_query.UseQueryResult<types.Page, unknown>;
+declare const usePage: (slug: string, language?: string) => _tanstack_react_query.UseQueryResult<types.Page, Error>;
 
 /**
  * Values returned from usePages
@@ -1266,7 +1294,7 @@ declare const usePagesPublic: UsePagesPublicType;
 declare const useTagsPublic: (page?: number, pageSize?: number, options?: {
     q?: string;
     language?: string;
-}) => react_query.UseQueryResult<{
+}) => _tanstack_react_query.UseQueryResult<{
     items: string[];
     pagination: {
         page: number;
@@ -1274,7 +1302,7 @@ declare const useTagsPublic: (page?: number, pageSize?: number, options?: {
         totalItems: number;
         totalPages: number;
     };
-}, unknown>;
+}, Error>;
 
 declare const useReactBricksContext: () => types.IReactBricksContext;