@dotcms/react 0.0.1-alpha.1 → 0.0.1-alpha.11

package/src/lib/components/Column/Column.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-import { PageProviderContext } from '../PageProvider/PageProvider';
-interface ColumnProps {
-    readonly column: PageProviderContext['layout']['body']['rows'][0]['columns'][0];
-}
-export declare function Column({ column }: ColumnProps): JSX.Element;
-export {};

package/src/lib/components/Container/Container.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="react" />
-import { PageProviderContext } from '../PageProvider/PageProvider';
-export interface ContainerProps {
-    readonly containerRef: PageProviderContext['layout']['body']['rows'][0]['columns'][0]['containers'][0];
-}
-export declare function Container({ containerRef }: ContainerProps): JSX.Element;

package/src/lib/components/Row/Row.d.ts

@@ -1,25 +0,0 @@
-/// <reference types="react" />
-import { PageProviderContext } from '../PageProvider/PageProvider';
-/**
- * Props for the row component
- *
- * @interface RowProps
- *
- */
-export interface RowProps {
-    /**
-     * Row data
-     *
-     * @type {PageProviderContext['layout']['body']['rows'][0]}
-     * @memberof RowProps
-     */
-    row: PageProviderContext['layout']['body']['rows'][0];
-}
-/**
- * Renders a row
- *
- * @category Components
- * @param {React.ForwardedRef<HTMLDivElement, RowProps>} ref
- * @return {*}
- */
-export declare const Row: import("react").ForwardRefExoticComponent<RowProps & import("react").RefAttributes<HTMLDivElement>>;

package/src/lib/contexts/PageContext.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="react" />
-import { PageProviderContext } from '../components/PageProvider/PageProvider';
-export declare const PageContext: import("react").Context<PageProviderContext | null>;

package/src/lib/hooks/usePageEditor.d.ts

@@ -1,48 +0,0 @@
-/// <reference types="react" />
-/**
- * `PageEditorOptions` is an interface that defines the options for the `usePageEditor` hook.
- * It includes an optional `reloadFunction` that is called when the editor needs to reload the page to get changes,
- * and an optional `pathname` that represents the path of the page that the editor is editing.
- *
- * @interface PageEditorOptions
- *
- * @property {Function} reloadFunction - An optional function that is called when the editor needs to reload the page to get changes.
- * @property {string} pathname - An optional string that represents the path of the page that the editor is editing.
- */
-interface PageEditorOptions {
-    /**
-     * `reloadFunction` is an optional function that can be provided to the `PageEditorOptions` object.
-     * It is called when the dotcms editor needs to reload the page to get changes.
-     *
-     * @property {Function} reloadFunction
-     * @default window.location.reload
-     * @memberof PageEditorOptions
-     * @type {() => void}
-     * @optional
-     */
-    reloadFunction?: () => void;
-    /**
-     * `pathname` is an optional string that can be provided to the `PageEditorOptions` object.
-     * It represents the path of the page that the editor is editing.
-     * When this path changes, the editor will update its own state and reload the page to get the changes.
-     * @property {string} pathname
-     * @memberof PageEditorOptions
-     * @type {string}
-     * @optional
-     */
-    pathname?: string;
-}
-/**
- * `usePageEditor` is a custom React hook that sets up the page editor for a DotCMS page.
- * It takes a `PageEditorOptions` object as a parameter and returns a reference to the rows of the page.
- *
- * This hook is the main brigde between your webapp and the dotcms page editor.
- *
- *
- * @category Hooks
- * @param {PageEditorOptions} props - The options for the page editor. Includes a `reloadFunction` and a `pathname`.
- * @returns {React.RefObject<HTMLDivElement>[]} - A reference to the rows of the page.
- * @throws {Error} - Throws an error if the `pathname` is not provided.
- */
-export declare const usePageEditor: (props: PageEditorOptions) => import("react").MutableRefObject<HTMLDivElement[]>;
-export {};

package/src/lib/mocks/mockPageContext.d.ts

@@ -1,2 +0,0 @@
-import { PageProviderContext } from '../components/PageProvider/PageProvider';
-export declare const mockPageContext: PageProviderContext;

package/src/lib/utils/utils.d.ts

@@ -1,50 +0,0 @@
-import { ContainerData, PageProviderContext } from '../components/PageProvider/PageProvider';
-export declare function getPageElementBound(rowsNodes: HTMLDivElement[] | null): {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    columns: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-        containers: {
-            x: number;
-            y: number;
-            width: number;
-            height: number;
-            payload: string | undefined;
-            contentlets: {
-                x: number;
-                y: number;
-                width: number;
-                height: number;
-                payload: string | undefined;
-            }[];
-        }[];
-    }[];
-}[];
-export declare const getPageContainers: (containers: ContainerData) => {
-    identifier: string;
-    uuid: string;
-    contentletsId: string[];
-}[];
-export declare const getContainersData: (containers: ContainerData, containerRef: PageProviderContext['layout']['body']['rows'][0]['columns'][0]['containers'][0]) => {
-    acceptTypes: string;
-    contentlets: {
-        contentType: string;
-        identifier: string;
-        title: string;
-        inode: string;
-        widgetTitle?: string | undefined;
-    }[];
-    pageContainers: {
-        identifier: string;
-        uuid: string;
-        contentletsId: string[];
-    }[];
-    path: string;
-    identifier: string;
-    maxContentlets: number;
-};