react-bricks 4.1.3 → 4.2.0-beta.1

package/react-bricks.d.ts

@@ -1,64 +1,26 @@
 import * as React from 'react';
 import React__default from 'react';
-import { BaseEditor, Element, Descendant, Editor as Editor$1, Node } from 'slate';
+import { Descendant, Editor as Editor$1, BaseEditor, Element, Node } from 'slate';
+import { RenderElementProps, RenderLeafProps, ReactEditor } from 'slate-react';
 import { HistoryEditor } from 'slate-history';
-import { ReactEditor, RenderElementProps, RenderLeafProps } from 'slate-react';
 import * as react_query from 'react-query';
 import { UseQueryResult } from 'react-query';
 export { v4 as uuid } from 'uuid';
 
+declare const useAdminContext: () => types.IReadAdminContext;
+
 /**
- * CustomElement for Slate
- */
-declare type CustomElement = {
-    type: string;
-    element?: Element;
-    children: CustomText[];
-    [key: string]: any;
-};
-/**
- * CustomText for Slate
+ * Props for Link component
  */
-declare type CustomText = {
-    text?: string;
-    [key: string]: any;
-};
-declare module 'slate' {
-    interface CustomTypes {
-        Editor: BaseEditor & ReactEditor & HistoryEditor;
-        Element: CustomElement;
-        Text: CustomText;
-    }
-}
-interface BaseTextProps {
-    renderBlock?: (props: RenderElementProps) => JSX.Element;
-    placeholder?: string;
-    renderPlaceholder?: (props: {
-        children: any;
-    }) => JSX.Element;
-    multiline?: boolean;
-    softLineBreak?: boolean;
-}
-interface TextPropsWithPropName extends BaseTextProps {
-    propName: string;
-    metaFieldName?: never;
-    customFieldName?: never;
-}
-interface TextPropsWithMetaFieldName extends BaseTextProps {
-    propName?: never;
-    metaFieldName: 'title' | 'description' | 'language';
-    customFieldName?: never;
-}
-interface TextPropsWithCustomFieldName extends BaseTextProps {
-    propName?: never;
-    metaFieldName?: never;
-    customFieldName: string;
+interface LinkProps {
+    href: string;
+    target?: string;
+    className?: string;
+    activeClassName?: string;
+    simpleAnchor?: boolean;
 }
-/**
- * Props for Text component
- */
-declare type TextProps = TextPropsWithPropName | TextPropsWithMetaFieldName | TextPropsWithCustomFieldName;
-declare const Text: React.FC<TextProps>;
+declare type LinkPropsReal = React.PropsWithChildren<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, keyof LinkProps> & LinkProps>;
+declare const Link: React.FC<LinkPropsReal>;
 
 declare namespace types {
     export const EmbedProp = "RB_PAGE_EMBED";
@@ -381,6 +343,7 @@ declare namespace types {
         previewImageUrl?: string;
         props: T;
     };
+    export type RepeaterItems = IContentBlock[] | Omit<IContentBlock, 'id'>[] | Props[];
     /**
      * A Language for i18n
      */
@@ -418,7 +381,7 @@ declare namespace types {
         label: string;
         getDefaultProps?: () => Partial<T>;
         hideFromAddMenu?: boolean;
-        sideEditProps?: Array<ISideEditProp | ISideGroup>;
+        sideEditProps?: Array<ISideEditProp<T> | ISideGroup<T>>;
         repeaterItems?: IRepeaterItem[];
         newItemMenuOpen?: boolean;
         groupByRepeater?: boolean;
@@ -483,13 +446,13 @@ declare namespace types {
     /**
      * Sidebar edit Props for a Page
      */
-    export interface ISideEditPropPage {
+    export interface ISideEditPropPage<T = Props> {
         name: string;
         label: string;
         type: SideEditPropType;
         component?: React__default.FC<ICustomKnobProps>;
-        validate?: (value: any, props?: Props) => boolean | string;
-        show?: (props: Props, page: Page, user: User) => boolean;
+        validate?: (value: any, props?: T) => boolean | string;
+        show?: (props: T, page?: Page, user?: User) => boolean;
         helperText?: string;
         textareaOptions?: {
             height?: number;
@@ -518,18 +481,18 @@ declare namespace types {
     /**
      * Sidebar Edit Props
      */
-    export interface ISideEditProp extends ISideEditPropPage {
+    export interface ISideEditProp<T = Props> extends ISideEditPropPage<T> {
         shouldRefreshText?: boolean;
         shouldRefreshStyles?: boolean;
     }
     /**
      * A collapsible Group of sidebar Props
      */
-    export interface ISideGroup {
+    export interface ISideGroup<T = Props> {
         groupName: string;
         defaultOpen?: boolean;
-        show?: (props: Props) => boolean;
-        props: ISideEditProp[] | ISideEditPropPage[];
+        show?: (props: T, page?: Page, user?: User) => boolean;
+        props: ISideEditProp<T>[] | ISideEditPropPage<T>[];
     }
     /**
      * Image Crop interface
@@ -867,23 +830,77 @@ declare namespace types {
 }
 
 /**
- * Props for RichTextExt (v3)
+ * Props for Text
  */
-interface RichTextProps$1 {
-    renderBlock?: (props: RenderElementProps) => JSX.Element;
-    placeholder?: string;
-    renderPlaceholder?: (props: {
-        children: any;
-    }) => JSX.Element;
-    plugins?: types.RichTextPlugin[];
-    multiline?: boolean;
-    softLineBreak?: boolean;
+interface FileProps {
+    propName: string;
+    renderBlock: (props: types.IFileSource | null) => JSX.Element;
+    allowedExtensions?: string[];
+}
+declare const File$1: React__default.FC<FileProps>;
+
+/**
+ * Arguments for the renderWrapper function
+ */
+interface IRenderWrapperArgs {
+    children: React.ReactNode;
+    width?: number;
+    height?: number;
+}
+/**
+ * renderWrapper function type
+ */
+declare type RenderWrapper = (args: IRenderWrapperArgs) => React.ReactElement;
+interface PlaceholderProps {
+    aspectRatio?: number;
+    maxWidth?: number;
+    isDarkColorMode?: boolean;
+    isAdmin: boolean;
+}
+interface SharedImageProps {
+    readonly?: boolean;
+    alt: string;
+    noLazyLoad?: boolean;
+    containerClassName?: string;
+    containerStyle?: React.CSSProperties;
+    imageClassName?: string;
+    imageStyle?: React.CSSProperties;
+    noWrapper?: boolean;
+    sizes?: string;
+    loading?: 'lazy' | 'eager';
+    renderWrapper?: RenderWrapper;
+    useNativeLazyLoading?: boolean;
+    useWebP?: boolean;
+    placeholder?: (props: PlaceholderProps) => string;
+}
+interface EditableImage extends SharedImageProps {
+    readonly?: false;
     propName?: string;
-    metaFieldName?: 'title' | 'description' | 'language';
+    metaFieldName?: 'image';
     customFieldName?: string;
-    customFieldPlainText?: boolean;
+    aspectRatio?: number;
+    maxWidth?: number;
+}
+interface ReadOnlyImage extends SharedImageProps {
+    readonly: true;
+    source: types.IImageSource;
 }
-declare const RichText: React.FC<RichTextProps$1>;
+/**
+ * Props for Image
+ */
+declare type ImageProps = EditableImage | ReadOnlyImage;
+declare const Image$1: React.FC<ImageProps>;
+
+/**
+ * Props for Repeater
+ */
+interface RepeaterProps {
+    propName: string;
+    itemProps?: types.Props;
+    renderWrapper?: (items: React.ReactElement) => React.ReactElement;
+    renderItemWrapper?: (item: React.ReactElement, index: number, itemsCount: number) => React.ReactElement;
+}
+declare const Repeater: React.FC<RepeaterProps>;
 
 /**
  * Props for renderLink render function
@@ -939,96 +956,80 @@ interface RichTextPropsWithCustomFieldName extends BaseRichTextProps {
 /**
  * Props for RichText component
  */
-declare type RichTextProps = RichTextPropsWithPropName | RichTextPropsWithMetaFieldName | RichTextPropsWithCustomFieldName;
-declare const CompatibleRichText: React__default.FC<RichTextProps>;
+declare type RichTextProps$1 = RichTextPropsWithPropName | RichTextPropsWithMetaFieldName | RichTextPropsWithCustomFieldName;
+declare const CompatibleRichText: React__default.FC<RichTextProps$1>;
 
 /**
- * Arguments for the renderWrapper function
- */
-interface IRenderWrapperArgs {
-    children: React.ReactNode;
-    width?: number;
-    height?: number;
-}
-/**
- * renderWrapper function type
+ * Props for RichTextExt (v3)
  */
-declare type RenderWrapper = (args: IRenderWrapperArgs) => React.ReactElement;
-interface PlaceholderProps {
-    aspectRatio?: number;
-    maxWidth?: number;
-    isDarkColorMode?: boolean;
-    isAdmin: boolean;
-}
-interface SharedImageProps {
-    readonly?: boolean;
-    alt: string;
-    noLazyLoad?: boolean;
-    containerClassName?: string;
-    containerStyle?: React.CSSProperties;
-    imageClassName?: string;
-    imageStyle?: React.CSSProperties;
-    noWrapper?: boolean;
-    sizes?: string;
-    loading?: 'lazy' | 'eager';
-    renderWrapper?: RenderWrapper;
-    useNativeLazyLoading?: boolean;
-    useWebP?: boolean;
-    placeholder?: (props: PlaceholderProps) => string;
-}
-interface EditableImage extends SharedImageProps {
-    readonly?: false;
+interface RichTextProps {
+    renderBlock?: (props: RenderElementProps) => JSX.Element;
+    placeholder?: string;
+    renderPlaceholder?: (props: {
+        children: any;
+    }) => JSX.Element;
+    plugins?: types.RichTextPlugin[];
+    multiline?: boolean;
+    softLineBreak?: boolean;
     propName?: string;
-    metaFieldName?: 'image';
+    metaFieldName?: 'title' | 'description' | 'language';
     customFieldName?: string;
-    aspectRatio?: number;
-    maxWidth?: number;
-}
-interface ReadOnlyImage extends SharedImageProps {
-    readonly: true;
-    source: types.IImageSource;
+    customFieldPlainText?: boolean;
 }
-/**
- * Props for Image
- */
-declare type ImageProps = EditableImage | ReadOnlyImage;
-declare const Image$1: React.FC<ImageProps>;
+declare const RichText: React.FC<RichTextProps>;
 
 /**
- * Props for Text
+ * CustomElement for Slate
  */
-interface FileProps {
-    propName: string;
-    renderBlock: (props: types.IFileSource | null) => JSX.Element;
-    allowedExtensions?: string[];
-}
-declare const File$1: React__default.FC<FileProps>;
-
+declare type CustomElement = {
+    type: string;
+    element?: Element;
+    children: CustomText[];
+    [key: string]: any;
+};
 /**
- * Props for Repeater
+ * CustomText for Slate
  */
-interface RepeaterProps {
+declare type CustomText = {
+    text?: string;
+    [key: string]: any;
+};
+declare module 'slate' {
+    interface CustomTypes {
+        Editor: BaseEditor & ReactEditor & HistoryEditor;
+        Element: CustomElement;
+        Text: CustomText;
+    }
+}
+interface BaseTextProps {
+    renderBlock?: (props: RenderElementProps) => JSX.Element;
+    placeholder?: string;
+    renderPlaceholder?: (props: {
+        children: any;
+    }) => JSX.Element;
+    multiline?: boolean;
+    softLineBreak?: boolean;
+}
+interface TextPropsWithPropName extends BaseTextProps {
     propName: string;
-    itemProps?: types.Props;
-    renderWrapper?: (items: React.ReactElement) => React.ReactElement;
-    renderItemWrapper?: (item: React.ReactElement, index: number, itemsCount: number) => React.ReactElement;
+    metaFieldName?: never;
+    customFieldName?: never;
+}
+interface TextPropsWithMetaFieldName extends BaseTextProps {
+    propName?: never;
+    metaFieldName: 'title' | 'description' | 'language';
+    customFieldName?: never;
+}
+interface TextPropsWithCustomFieldName extends BaseTextProps {
+    propName?: never;
+    metaFieldName?: never;
+    customFieldName: string;
 }
-declare const Repeater: React.FC<RepeaterProps>;
-
 /**
- * Props for Link component
+ * Props for Text component
  */
-interface LinkProps {
-    href: string;
-    target?: string;
-    className?: string;
-    activeClassName?: string;
-    simpleAnchor?: boolean;
-}
-declare type LinkPropsReal = React.PropsWithChildren<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, keyof LinkProps> & LinkProps>;
-declare const Link: React.FC<LinkPropsReal>;
-
-declare const useAdminContext: () => types.IReadAdminContext;
+declare type TextProps = TextPropsWithPropName | TextPropsWithMetaFieldName | TextPropsWithCustomFieldName;
+declare const Text: React.FC<TextProps>;
 
 declare const usePageValues: () => [types.PageValues, (pageData: types.PartialPage) => void];
 
@@ -1052,6 +1053,7 @@ declare const ReactBricks: React.FC<types.ReactBricksConfig & {
  */
 interface PageViewerProps {
     page: types.Page | null | undefined;
+    main?: boolean;
     showClickToEdit?: boolean;
 }
 declare const PageViewer: React.FC<PageViewerProps>;
@@ -1061,10 +1063,10 @@ interface JsonLdProps {
 }
 declare const JsonLd: React__default.FC<JsonLdProps>;
 
-declare const renderJsonLd: React__default.FC<types.Page>;
-
 declare const getSchemaOrgData: (page: types.Page) => string | null;
 
+declare const renderJsonLd: React__default.FC<types.Page>;
+
 interface MetaProps {
     page: types.Page;
 }
@@ -1295,12 +1297,10 @@ declare namespace index {
   };
 }
 
-declare const Editor: React.FC;
-
-declare const Playground: () => React.JSX.Element;
-
 declare const AppSettings: React.FC;
 
+declare const Editor: React.FC;
+
 /**
  * File
  */
@@ -1350,6 +1350,8 @@ interface MediaLibraryProps {
 }
 declare const MediaLibrary: React__default.FC<MediaLibraryProps>;
 
+declare const Playground: () => React.JSX.Element;
+
 /**
  * Props of Admin component
  */