@dotcms/react
Version:
Official React Components library to render a dotCMS page.
72 lines (71 loc) • 2.71 kB
TypeScript
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 {};