MdxEditorField

API reference and demos for MdxEditorField.

Source

Import

import { MdxEditorField } from "@flanksource/clicky-ui/components";

Demos

No dedicated Storybook demo is available for this component yet.

The props table documents the component-specific surface. Standard DOM attributes inherited from React, such as className, event handlers, and accessibility attributes, may also be accepted when the component’s prop type extends a native element.

Props

Prop	Type	Default	Description
admonitions	boolean | MdxEditorAdmonitionOptions	—	—
aria-label	string	—	—
callouts	boolean | MdxEditorCalloutOptions	—	Register `<CalloutBox>` with its own node editor. Off by default.
className	string	—	—
codeBlocks	boolean | MdxEditorCodeBlockOptions	—	—
codeMirror	boolean | MdxEditorCodeMirrorOptions	—	—
commitInitialMarkdownNormalize	boolean	false	—
contentClassName	string	—	—
diffMode	boolean | MdxEditorViewMode | MdxEditorDiffModeOptions	—	—
disabled	boolean	false	—
frontmatter	boolean	—	—
headings	boolean | { allowedHeadingLevels?: readonly MdxEditorHeadingLevel[]; }	—	—
id	string	—	—
images	boolean | MdxEditorImageOptions	—	—
jsxComponents	readonly MdxEditorJsxComponentDescriptor[]	—	Additional JSX blocks to register, for block types particular to the consuming application. Combined with `callouts` into one `jsxPlugin`.
links	boolean | MdxEditorLinkOptions	—	—
lists	boolean	—	—
markdownShortcuts	boolean	—	—
mdxSyntax	boolean	—	Parse the value as MDX: a JSX block with no registered descriptor loads in the generic JSX editor, keeping its attributes and children, instead of failing the import. Off by default, since MDX rejects HTML comments and stray tags that plain markdown allows.
onChange	(…) => void	—	—
placeholder	ReactNode	—	—
plugins	unknown[]	—	—
quote	boolean	—	—
readOnly	boolean	false	—
size	enum	md	—
tables	boolean	—	—
textareaClassName	string	—	—
thematicBreak	boolean	—	—
toolbar	boolean | MdxEditorToolbarOptions	—	—
value	string	—	—