@massds/mayflower-react
Version:
React versions of Mayflower design system UI components
29 lines (28 loc) • 1.13 kB
TypeScript
/**
* RichText module.
* @module @massds/mayflower-react/RichText
*/
import React from 'react';
export interface RichTextProps {
/** The raw html nodes that you want to render. */
children?: React.ReactNode;
/** The stringified raw html that you want to render. If children exist, will render children instead of rawHtml */
rawHtml?: string;
/** A className that you want to component to reference. */
className?: string;
/** An id to be rendered on the component. */
id?: string;
/** A valid html tag you want the component wrapper to be. By default, this is a `div`. */
htmlTag?: string;
/** The transform function will be called for every node that is parsed by ReactHtmlParser.
* See documentation of html-react-parser for the transform function: https://www.npmjs.com/package/html-react-parser#transform-function
* */
transform?(...args: unknown[]): unknown;
}
declare const RichText: {
({ className, id, htmlTag, rawHtml, transform, children, ...rest }: RichTextProps): any;
defaultProps: {
htmlTag: string;
};
};
export default RichText;