@dotcms/react
Version:
Official React Components library to render a dotCMS page.
41 lines (40 loc) • 1.48 kB
TypeScript
import { DotCMSBasicContentlet } from '@dotcms/types';
/**
* @internal
*
* Type definition for components that can be used as fallback when no matching component is found
*/
export type NoComponentType = React.ComponentType<DotCMSBasicContentlet>;
/**
* @internal
*
* Props for the FallbackComponent
* @interface DotCMSFallbackComponentProps
* @property {React.ComponentType<DotCMSBasicContentlet>} [UserNoComponent] - Optional custom component to render when no matching component is found
* @property {DotCMSBasicContentlet} [contentlet] - The contentlet that couldn't be rendered
*/
interface DotCMSFallbackComponentProps {
contentlet: DotCMSBasicContentlet;
UserNoComponent?: React.ComponentType<DotCMSBasicContentlet>;
}
/**
* @internal
*
* Renders a fallback component when no matching component is found for a content type
*
* @component
* @param {DotCMSFallbackComponentProps} props - Component properties
* @param {NoComponentType} [props.UserNoComponent] - Optional custom component to render
* @param {DotCMSContentlet} [props.contentlet] - The contentlet that couldn't be rendered
* @returns {JSX.Element} The rendered fallback component
*
* @example
* ```tsx
* <FallbackComponent
* UserNoComponent={CustomNoComponent}
* contentlet={contentlet}
* />
* ```
*/
export declare function FallbackComponent({ UserNoComponent, contentlet }: DotCMSFallbackComponentProps): import("react/jsx-runtime").JSX.Element | null;
export {};