@dotcms/react
Version:
Official React Components library to render a dotCMS page.
32 lines (31 loc) • 997 B
TypeScript
import { DotCMSBasicContentlet } from '@dotcms/types';
import { DotCMSEditableTextProps } from './utils';
/**
* Allows inline edit content pulled from dotCMS API using TinyMCE editor
*
* @export
* @component
* @param {Readonly<DotCMSEditableTextProps>} props {
* mode = 'plain',
* format = 'text',
* contentlet,
* fieldName = ''
* }
* @example
* ```javascript
* import { DotCMSEditableText } from '@dotcms/react';
*
* const MyContentletWithTitle = ({ contentlet }) => (
* <h2>
* <DotCMSEditableText
* contentlet={contentlet}
* fieldName="title"
* mode='full'
* format='text'/>
* </h2>
* );
* ```
* @returns {JSX.Element} A component to edit content inline
*/
export declare function DotCMSEditableText<T extends DotCMSBasicContentlet>({ mode, format, contentlet, fieldName }: Readonly<DotCMSEditableTextProps<T>>): import("react/jsx-runtime").JSX.Element;
export default DotCMSEditableText;