import DOMPurify from 'dompurify'; import React from 'react'; import './Markdown.less'; export interface IMarkdownProps { [key: string]: any; /** markdown */ message: string; /** optional tag */ tag?: string; /** trim the contents before generating markdown; markdown treats four leading spaces as a
tag, so if you are
* using string templates and the content starts on a new line, you probably want this set to true */
trim?: boolean;
/** The className(s) to apply to the tag (.Markdown class is always applied) */
className?: string;
/** Options passed to DOMPurify. Examples: https://github.com/cure53/DOMPurify/tree/master/demos#what-is-this */
options?: DOMPurify.Config;
}
/**
* Renders markdown into a div (or some other tag)
* Extra props are passed through to the rendered tag
*/
export declare function Markdown(props: IMarkdownProps): React.DOMElement<{
className: string;
children?: React.ReactNode;
dangerouslySetInnerHTML?: {
__html: string;
};
onCopy?: React.ClipboardEventHandler;
onCopyCapture?: React.ClipboardEventHandler;
onCut?: React.ClipboardEventHandler;
onCutCapture?: React.ClipboardEventHandler;
onPaste?: React.ClipboardEventHandler;
onPasteCapture?: React.ClipboardEventHandler;
onCompositionEnd?: React.CompositionEventHandler;
onCompositionEndCapture?: React.CompositionEventHandler;
onCompositionStart?: React.CompositionEventHandler;
onCompositionStartCapture?: React.CompositionEventHandler;
onCompositionUpdate?: React.CompositionEventHandler;
onCompositionUpdateCapture?: React.CompositionEventHandler;
onFocus?: React.FocusEventHandler;
onFocusCapture?: React.FocusEventHandler;
onBlur?: React.FocusEventHandler;
onBlurCapture?: React.FocusEventHandler;
onChange?: React.FormEventHandler;
onChangeCapture?: React.FormEventHandler;
onBeforeInput?: React.FormEventHandler;
onBeforeInputCapture?: React.FormEventHandler;
onInput?: React.FormEventHandler;
onInputCapture?: React.FormEventHandler;
onReset?: React.FormEventHandler;
onResetCapture?: React.FormEventHandler;
onSubmit?: React.FormEventHandler;
onSubmitCapture?: React.FormEventHandler;
onInvalid?: React.FormEventHandler;
onInvalidCapture?: React.FormEventHandler;
onLoad?: React.ReactEventHandler;
onLoadCapture?: React.ReactEventHandler;
onError?: React.ReactEventHandler;
onErrorCapture?: React.ReactEventHandler;
onKeyDown?: React.KeyboardEventHandler;
onKeyDownCapture?: React.KeyboardEventHandler;
onKeyPress?: React.KeyboardEventHandler;
onKeyPressCapture?: React.KeyboardEventHandler;
onKeyUp?: React.KeyboardEventHandler;
onKeyUpCapture?: React.KeyboardEventHandler;
onAbort?: React.ReactEventHandler;
onAbortCapture?: React.ReactEventHandler;
onCanPlay?: React.ReactEventHandler;
onCanPlayCapture?: React.ReactEventHandler;
onCanPlayThrough?: React.ReactEventHandler;
onCanPlayThroughCapture?: React.ReactEventHandler;
onDurationChange?: React.ReactEventHandler;
onDurationChangeCapture?: React.ReactEventHandler;
onEmptied?: React.ReactEventHandler;
onEmptiedCapture?: React.ReactEventHandler;
onEncrypted?: React.ReactEventHandler;
onEncryptedCapture?: React.ReactEventHandler;
onEnded?: React.ReactEventHandler;
onEndedCapture?: React.ReactEventHandler;
onLoadedData?: React.ReactEventHandler;
onLoadedDataCapture?: React.ReactEventHandler;
onLoadedMetadata?: React.ReactEventHandler;
onLoadedMetadataCapture?: React.ReactEventHandler;
onLoadStart?: React.ReactEventHandler;
onLoadStartCapture?: React.ReactEventHandler;
onPause?: React.ReactEventHandler;
onPauseCapture?: React.ReactEventHandler;
onPlay?: React.ReactEventHandler;
onPlayCapture?: React.ReactEventHandler;
onPlaying?: React.ReactEventHandler;
onPlayingCapture?: React.ReactEventHandler;
onProgress?: React.ReactEventHandler;
onProgressCapture?: React.ReactEventHandler;
onRateChange?: React.ReactEventHandler;
onRateChangeCapture?: React.ReactEventHandler;
onSeeked?: React.ReactEventHandler;
onSeekedCapture?: React.ReactEventHandler;
onSeeking?: React.ReactEventHandler;
onSeekingCapture?: React.ReactEventHandler;
onStalled?: React.ReactEventHandler;
onStalledCapture?: React.ReactEventHandler;
onSuspend?: React.ReactEventHandler;
onSuspendCapture?: React.ReactEventHandler;
onTimeUpdate?: React.ReactEventHandler;
onTimeUpdateCapture?: React.ReactEventHandler;
onVolumeChange?: React.ReactEventHandler;
onVolumeChangeCapture?: React.ReactEventHandler;
onWaiting?: React.ReactEventHandler;
onWaitingCapture?: React.ReactEventHandler;
onAuxClick?: React.MouseEventHandler;
onAuxClickCapture?: React.MouseEventHandler;
onClick?: React.MouseEventHandler;
onClickCapture?: React.MouseEventHandler;
onContextMenu?: React.MouseEventHandler;
onContextMenuCapture?: React.MouseEventHandler;
onDoubleClick?: React.MouseEventHandler;
onDoubleClickCapture?: React.MouseEventHandler;
onDrag?: React.DragEventHandler;
onDragCapture?: React.DragEventHandler;
onDragEnd?: React.DragEventHandler;
onDragEndCapture?: React.DragEventHandler;
onDragEnter?: React.DragEventHandler;
onDragEnterCapture?: React.DragEventHandler;
onDragExit?: React.DragEventHandler;
onDragExitCapture?: React.DragEventHandler;
onDragLeave?: React.DragEventHandler;
onDragLeaveCapture?: React.DragEventHandler;
onDragOver?: React.DragEventHandler;
onDragOverCapture?: React.DragEventHandler;
onDragStart?: React.DragEventHandler;
onDragStartCapture?: React.DragEventHandler;
onDrop?: React.DragEventHandler;
onDropCapture?: React.DragEventHandler;
onMouseDown?: React.MouseEventHandler;
onMouseDownCapture?: React.MouseEventHandler;
onMouseEnter?: React.MouseEventHandler;
onMouseLeave?: React.MouseEventHandler;
onMouseMove?: React.MouseEventHandler;
onMouseMoveCapture?: React.MouseEventHandler;
onMouseOut?: React.MouseEventHandler;
onMouseOutCapture?: React.MouseEventHandler;
onMouseOver?: React.MouseEventHandler;
onMouseOverCapture?: React.MouseEventHandler;
onMouseUp?: React.MouseEventHandler;
onMouseUpCapture?: React.MouseEventHandler;
onSelect?: React.ReactEventHandler;
onSelectCapture?: React.ReactEventHandler;
onTouchCancel?: React.TouchEventHandler;
onTouchCancelCapture?: React.TouchEventHandler;
onTouchEnd?: React.TouchEventHandler;
onTouchEndCapture?: React.TouchEventHandler;
onTouchMove?: React.TouchEventHandler;
onTouchMoveCapture?: React.TouchEventHandler;
onTouchStart?: React.TouchEventHandler;
onTouchStartCapture?: React.TouchEventHandler;
onPointerDown?: React.PointerEventHandler;
onPointerDownCapture?: React.PointerEventHandler;
onPointerMove?: React.PointerEventHandler;
onPointerMoveCapture?: React.PointerEventHandler;
onPointerUp?: React.PointerEventHandler;
onPointerUpCapture?: React.PointerEventHandler;
onPointerCancel?: React.PointerEventHandler;
onPointerCancelCapture?: React.PointerEventHandler;
onPointerEnter?: React.PointerEventHandler;
onPointerEnterCapture?: React.PointerEventHandler;
onPointerLeave?: React.PointerEventHandler;
onPointerLeaveCapture?: React.PointerEventHandler;
onPointerOver?: React.PointerEventHandler;
onPointerOverCapture?: React.PointerEventHandler;
onPointerOut?: React.PointerEventHandler;
onPointerOutCapture?: React.PointerEventHandler;
onGotPointerCapture?: React.PointerEventHandler;
onGotPointerCaptureCapture?: React.PointerEventHandler;
onLostPointerCapture?: React.PointerEventHandler;
onLostPointerCaptureCapture?: React.PointerEventHandler;
onScroll?: React.UIEventHandler;
onScrollCapture?: React.UIEventHandler;
onWheel?: React.WheelEventHandler;
onWheelCapture?: React.WheelEventHandler;
onAnimationStart?: React.AnimationEventHandler;
onAnimationStartCapture?: React.AnimationEventHandler;
onAnimationEnd?: React.AnimationEventHandler;
onAnimationEndCapture?: React.AnimationEventHandler;
onAnimationIteration?: React.AnimationEventHandler;
onAnimationIterationCapture?: React.AnimationEventHandler;
onTransitionEnd?: React.TransitionEventHandler;
onTransitionEndCapture?: React.TransitionEventHandler;
}, Element>;
export declare const toMarkdown: (message: string, options?: DOMPurify.Config, inline?: boolean) => JSX.Element;