@dotcms/react 0.0.1-alpha.38 → 0.0.1-alpha.39

package/src/lib/components/BlockEditorRenderer/blocks/Image.d.ts

@@ -1,8 +0,0 @@
-import { ContentNode } from '../../../models/content-node.interface';
-/**
- * Renders an image component for dotCMS.
- *
- * @param props - The props for the DotCMSImage component.
- * @returns The rendered image component.
- */
-export declare const DotCMSImage: (props: ContentNode) => import("react/jsx-runtime").JSX.Element;

package/src/lib/components/BlockEditorRenderer/blocks/Table.d.ts

@@ -1,16 +0,0 @@
-import React from 'react';
-import { ContentNode } from '../../../models/content-node.interface';
-interface TableRendererProps {
-    content: ContentNode[];
-    blockEditorItem: React.FC<{
-        content: ContentNode[];
-    }>;
-}
-/**
- * Renders a table component for the Block Editor.
- *
- * @param content - The content of the table.
- * @param blockEditorItem - The Block Editor item component.
- */
-export declare const TableRenderer: React.FC<TableRendererProps>;
-export {};

package/src/lib/components/BlockEditorRenderer/blocks/Texts.d.ts

@@ -1,71 +0,0 @@
-import { BlockProps } from '../../../models/blocks.interface';
-import { ContentNode, HeadingProps, LinkProps, ParagraphProps } from '../../../models/content-node.interface';
-/**
- * Renders the text in bold.
- *
- * @param children - The content to be rendered in bold.
- */
-export declare const Bold: ({ children }: BlockProps) => import("react/jsx-runtime").JSX.Element;
-/**
- * Renders the text in italic format.
- *
- * @param children - The content to be rendered in italic.
- */
-export declare const Italic: ({ children }: BlockProps) => import("react/jsx-runtime").JSX.Element;
-/**
- * Renders a strike-through text.
- *
- * @param children - The content to be rendered within the strike-through element.
- */
-export declare const Strike: ({ children }: BlockProps) => import("react/jsx-runtime").JSX.Element;
-/**
- * Renders an underline element for the given children.
- *
- * @param children - The content to be underlined.
- */
-export declare const Underline: ({ children }: BlockProps) => import("react/jsx-runtime").JSX.Element;
-/**
- * Renders a paragraph element.
- *
- * @param children - The content of the paragraph.
- * @param attrs - The style attributes for the paragraph.
- * @returns The rendered paragraph element.
- */
-export declare const Paragraph: ({ children, attrs }: ParagraphProps) => import("react/jsx-runtime").JSX.Element;
-/**
- * Renders a link component.
- *
- * @param children - The content of the link.
- * @param attrs - The attributes to be applied to the link.
- * @returns The rendered link component.
- */
-export declare const Link: ({ children, attrs }: LinkProps) => import("react/jsx-runtime").JSX.Element;
-/**
- * Renders a heading element with the specified level.
- *
- * @param children - The content of the heading.
- * @param attrs - The attributes for the heading.
- * @returns The rendered heading element.
- */
-export declare const Heading: ({ children, attrs }: HeadingProps) => import("react/jsx-runtime").JSX.Element;
-/**
- * Renders the superscript text.
- *
- * @param children - The content to be rendered as superscript.
- */
-export declare const Superscript: ({ children }: BlockProps) => import("react/jsx-runtime").JSX.Element;
-/**
- * Renders a subscript element.
- *
- * @param children - The content to be rendered as subscript.
- */
-export declare const Subscript: ({ children }: BlockProps) => import("react/jsx-runtime").JSX.Element;
-type TextBlockProps = Omit<ContentNode, 'content' | 'attrs'>;
-/**
- * Renders a text block with optional marks.
- *
- * @param props - The props for the TextBlock component.
- * @returns The rendered text block.
- */
-export declare const TextBlock: (props: TextBlockProps) => string | import("react/jsx-runtime").JSX.Element | undefined;
-export {};

package/src/lib/components/BlockEditorRenderer/blocks/Video.d.ts

@@ -1,8 +0,0 @@
-import { ContentNode } from '../../../models/content-node.interface';
-/**
- * Renders a video component for displaying videos.
- *
- * @param props - The properties for the video component.
- * @returns The rendered video component.
- */
-export declare const DotCMSVideo: (props: ContentNode) => import("react/jsx-runtime").JSX.Element;

package/src/lib/components/BlockEditorRenderer/item/BlockEditorBlock.d.ts

@@ -1,12 +0,0 @@
-import { ContentNode, CustomRenderer } from '../../../models/content-node.interface';
-/**
- * Renders a block editor item based on the provided content and custom renderers.
- *
- * @param content - The content nodes to render.
- * @param customRenderers - Optional custom renderers for specific node types.
- * @returns The rendered block editor item.
- */
-export declare const BlockEditorBlock: ({ content, customRenderers }: {
-    content: ContentNode[];
-    customRenderers?: CustomRenderer;
-}) => import("react/jsx-runtime").JSX.Element[];

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

@@ -1,19 +0,0 @@
-import { DotCMSPageContext } from '../../models';
-/**
- * Props for Column component to render a column with its containers.
- *
- * @export
- * @interface ColumnProps
- */
-export interface ColumnProps {
-    readonly column: DotCMSPageContext['pageAsset']['layout']['body']['rows'][0]['columns'][0];
-}
-/**
- * Renders a Column with its containers using information provided by dotCMS Page API.
- *
- * @see {@link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas}
- * @export
- * @param {ColumnProps} { column }
- * @return {JSX.Element} Rendered column with containers
- */
-export declare function Column({ column }: ColumnProps): import("react/jsx-runtime").JSX.Element;

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

@@ -1,19 +0,0 @@
-import { DotCMSPageContext } from '../../models';
-/**
- * Props for the Container component.
- *
- * @export
- * @interface ContainerProps
- */
-export interface ContainerProps {
-    readonly containerRef: DotCMSPageContext['pageAsset']['layout']['body']['rows'][0]['columns'][0]['containers'][0];
-}
-/**
- * Renders a Container with its content using information provided by dotCMS Page API.
- *
- * @see {@link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas}
- * @export
- * @param {ContainerProps} { containerRef }
- * @return {JSX.Element} Rendered container with content
- */
-export declare function Container({ containerRef }: ContainerProps): import("react/jsx-runtime").JSX.Element;

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

@@ -1,31 +0,0 @@
-/// <reference types="react" />
-import { DotEditableTextProps } from './utils';
-/**
- * Allows inline edit content pulled from dotCMS API using TinyMCE editor
- *
- * @export
- * @component
- * @param {Readonly<DotEditableTextProps>} props {
- *     mode = 'plain',
- *     format = 'text',
- *     contentlet,
- *     fieldName = ''
- * }
- * @example
- * ```javascript
- * import { DotEditableText } from '@dotcms/react';
- *
- * const MyContentletWithTitle = ({ contentlet }) => (
- *     <h2>
- *         <DotEditableText
- *             contentlet={contentlet}
- *             fieldName="title"
- *             mode='full'
- *             format='text'/>
- *     </h2>
- * );
- * ```
- * @returns {JSX.Element} A component to edit content inline
- */
-export declare function DotEditableText({ mode, format, contentlet, fieldName }: Readonly<DotEditableTextProps>): JSX.Element;
-export default DotEditableText;

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

@@ -1,36 +0,0 @@
-import { IAllProps } from '@tinymce/tinymce-react';
-import { DotCMSContentlet } from '../../models';
-export type DOT_EDITABLE_TEXT_FORMAT = 'html' | 'text';
-export type DOT_EDITABLE_TEXT_MODE = 'minimal' | 'full' | 'plain';
-export interface DotEditableTextProps {
-    /**
-     * Represents the field name of the `contentlet` that can be edited
-     *
-     * @memberof DotEditableTextProps
-     */
-    fieldName: string;
-    /**
-     * Represents the format of the editor which can be `text` or `html`
-     *
-     * @type {DOT_EDITABLE_TEXT_FORMAT}
-     * @memberof DotEditableTextProps
-     */
-    format?: DOT_EDITABLE_TEXT_FORMAT;
-    /**
-     * Represents the mode of the editor which can be `plain`, `minimal`, or `full`
-     *
-     * @type {DOT_EDITABLE_TEXT_MODE}
-     * @memberof DotEditableTextProps
-     */
-    mode?: DOT_EDITABLE_TEXT_MODE;
-    /**
-     * Represents the `contentlet` that can be inline edited
-     *
-     * @type {DotCMSContentlet}
-     * @memberof DotEditableTextProps
-     */
-    contentlet: DotCMSContentlet;
-}
-export declare const TINYMCE_CONFIG: {
-    [key in DOT_EDITABLE_TEXT_MODE]: IAllProps['init'];
-};

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

@@ -1,26 +0,0 @@
-/// <reference types="react" />
-import { DotCMSPageContext } from '../../models';
-/**
- * Props for the row component
- *
- * @interface RowProps
- *
- */
-export interface RowProps {
-    /**
-     * Row data
-     *
-     * @type {DotCMSPageContext['layout']['body']['rows'][0]}
-     * @memberof RowProps
-     */
-    row: DotCMSPageContext['pageAsset']['layout']['body']['rows'][0];
-}
-/**
- * This component renders a row with all it's content using the layout provided by dotCMS Page API.
- *
- * @see {@link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas}
- * @category Components
- * @param {React.ForwardedRef<HTMLDivElement, RowProps>} ref
- * @return {JSX.Element} Rendered rows with columns
- */
-export declare const Row: import("react").ForwardRefExoticComponent<RowProps & import("react").RefAttributes<HTMLDivElement>>;

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

@@ -1,13 +0,0 @@
-import { DotcmsPageProps } from '../components/DotcmsLayout/DotcmsLayout';
-import { DotCMSPageContext } from '../models';
-/**
- * Custom Hook to handle the DotCMS editor interaction with the page.
- *
- * @category Hooks
- * @param {DotcmsPageProps} props {
- *     pageContext,
- *     config,
- * }
- * @returns {DotCMSPageContext} The context for a DotCMS page provided by the editor.
- */
-export declare const useDotcmsEditor: ({ pageContext, config }: DotcmsPageProps) => DotCMSPageContext;

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

@@ -1,8 +0,0 @@
-/// <reference types="react" />
-import { DotCMSPageContext, DotCMSContentlet } from '../models';
-export declare const dotcmsContentletMock: DotCMSContentlet;
-export declare const mockPageContext: DotCMSPageContext;
-export declare const MockContextRender: ({ children, mockContext }: {
-    children: JSX.Element;
-    mockContext: Partial<DotCMSPageContext>;
-}) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,43 +0,0 @@
-import { ContainerData, DotCMSPageContext } from '../models';
-/**
- * Get the container data from the containers object using the current container reference obtained from the layout.
- *
- * @param {ContainerData} containers
- * @param {DotCMSPageContext['pageAsset']['layout']['body']['rows'][0]['columns'][0]['containers'][0]} containerRef
- * @returns {Object} Container with all the data it has.
- */
-export declare const getContainersData: (containers: ContainerData, containerRef: DotCMSPageContext['pageAsset']['layout']['body']['rows'][0]['columns'][0]['containers'][0]) => {
-    acceptTypes: string;
-    contentlets: {
-        contentType: string;
-        identifier: string;
-        title: string;
-        inode: string;
-        onNumberOfPages: number;
-        widgetTitle?: string | undefined;
-        baseType: string;
-    }[];
-    variantId: string;
-    path: string;
-    identifier: string;
-    maxContentlets: number;
-    parentPermissionable: Record<string, string>;
-};
-/**
- * Combine classes into a single string.
- *
- * @param {string[]} classes
- * @returns {string} Combined classes
- */
-export declare const combineClasses: (classes: string[]) => string;
-/**
- * Get the start and end classes for the column based on the left offset and width.
- *
- * @param {number} start
- * @param {number} end
- * @returns {Object} Start and end classes
- */
-export declare const getPositionStyleClasses: (start: number, end: number) => {
-    startClass: string;
-    endClass: string;
-};