| defaultTag | | type | "string" |
|---|
| description | "Default tag name for the editor" |
|---|
| default | "p" |
|---|
|
|---|
| convertTextTags | | type | "object" |
|---|
| description | "Custom tags for text formatting buttons" |
|---|
| additionalProperties | |
|---|
| properties | | bold | | type | "string" |
|---|
| default | "STRONG" |
|---|
|
|---|
| underline | |
|---|
| italic | |
|---|
| strike | |
|---|
|
|---|
| default | | bold | "STRONG" |
|---|
| underline | "U" |
|---|
| italic | "EM" |
|---|
| strike | "DEL" |
|---|
|
|---|
|
|---|
| value | | type | "string" |
|---|
| description | "Initial HTML value of the editor" |
|---|
| default | "" |
|---|
|
|---|
| historyStackDelayTime | | type | "number" |
|---|
| description | "Delay time in milliseconds for recording history stack" |
|---|
| default | 400 |
|---|
|
|---|
| elementWhitelist | | type | "string" |
|---|
| description | "Additional tags to whitelist" |
|---|
| default | "" |
|---|
|
|---|
| elementBlacklist | | type | |
|---|
| description | "Tags to blacklist" |
|---|
| default | null |
|---|
|
|---|
| attributeWhitelist | | type | |
|---|
| description | "Attributes whitelist to keep in editor" |
|---|
| additionalProperties | |
|---|
| default | null |
|---|
|
|---|
| attributeBlacklist | | type | |
|---|
| description | "Attributes blacklist to remove from editor" |
|---|
| additionalProperties | |
|---|
| default | null |
|---|
|
|---|
| mode | | type | "string" |
|---|
| description | "Editor mode" |
|---|
| enum | | "classic" |
| "inline" |
| "balloon" |
| "balloon-always" |
|
|---|
| default | "classic" |
|---|
|
|---|
| rtl | | type | "boolean" |
|---|
| description | "Right to Left mode" |
|---|
| default | false |
|---|
|
|---|
| lineAttrReset | | type | "string" |
|---|
| description | "Attributes to delete at line break" |
|---|
| default | "" |
|---|
|
|---|
| toolbar_width | | oneOf | |
|---|
| description | "Width of toolbar for inline/balloon modes" |
|---|
| default | "auto" |
|---|
|
|---|
| toolbar_container | | oneOf | |
|---|
| description | "Custom container for toolbar" |
|---|
| default | null |
|---|
|
|---|
| toolbar_sticky | | oneOf | |
|---|
| description | "Top offset for sticky toolbar (-1, false, or null to turn off)" |
|---|
| default | 0 |
|---|
|
|---|
| toolbar_hide | | type | "boolean" |
|---|
| description | "Hide the toolbar" |
|---|
| default | false |
|---|
|
|---|
| fullScreenOffset | | oneOf | |
|---|
| description | "Top offset for fullscreen mode" |
|---|
| default | 0 |
|---|
|
|---|
| iframe | | type | "boolean" |
|---|
| description | "Use iframe to isolate content" |
|---|
| default | false |
|---|
|
|---|
| iframe_fullPage | | type | "boolean" |
|---|
| description | "Allow HTML, HEAD, BODY tags and DOCTYPE" |
|---|
| default | false |
|---|
|
|---|
| iframe_attributes | | type | |
|---|
| description | "Attributes for iframe element" |
|---|
| additionalProperties | |
|---|
| default | null |
|---|
|
|---|
| iframe_cssFileName | | oneOf | |
|---|
| description | "CSS filename for iframe" |
|---|
| default | "suneditor" |
|---|
|
|---|
| previewTemplate | | type | |
|---|
| description | "Template for preview (use {{contents}} placeholder)" |
|---|
| default | null |
|---|
|
|---|
| printTemplate | | type | |
|---|
| description | "Template for print (use {{contents}} placeholder)" |
|---|
| default | null |
|---|
|
|---|
| externalLibs | | type | "object" |
|---|
| description | "External library configurations (codeMirror, katex, mathjax)" |
|---|
| additionalProperties | true |
|---|
| properties | | codeMirror | | oneOf | | type | "object" |
|---|
| additionalProperties | true |
|---|
| properties | | options | | type | "object" |
|---|
| additionalProperties | true |
|---|
| properties | | mode | | type | "string" |
|---|
| default | "htmlmixed" |
|---|
|
|---|
| htmlMode | |
|---|
| lineNumbers | |
|---|
| lineWrapping | |
|---|
|
|---|
|
|---|
|
|---|
|
|
|
|---|
| description | "CodeMirror configuration for code view (src must be a CodeMirror constructor — not representable in JSON)" |
|---|
|
|---|
| katex | | oneOf | | type | "object" |
|---|
| additionalProperties | true |
|---|
| properties | | options | | type | "object" |
|---|
| additionalProperties | true |
|---|
| properties | | throwOnError | | type | "boolean" |
|---|
| default | false |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|
|
|---|
| description | "KaTeX configuration for math plugin (src must be a KaTeX constructor — not representable in JSON)" |
|---|
|
|---|
|
|---|
| default | |
|---|
|
|---|
| statusbar | | type | "boolean" |
|---|
| description | "Show status bar" |
|---|
| default | true |
|---|
|
|---|
| statusbar_showPathLabel | | type | "boolean" |
|---|
| description | "Show node structure in status bar" |
|---|
| default | true |
|---|
|
|---|
| statusbar_resizeEnable | | type | "boolean" |
|---|
| description | "Enable resizing" |
|---|
| default | true |
|---|
|
|---|
| statusbar_container | | oneOf | |
|---|
| description | "Custom container for status bar" |
|---|
| default | null |
|---|
|
|---|
| charCounter | | type | "boolean" |
|---|
| description | "Show character counter (auto-enabled if charCounter_max is set)" |
|---|
| default | false |
|---|
|
|---|
| charCounter_type | | type | "string" |
|---|
| description | "Character counting method" |
|---|
| enum | | "char" |
| "byte" |
| "byte-html" |
|
|---|
| default | "char" |
|---|
|
|---|
| charCounter_label | | type | |
|---|
| description | "Label for character counter" |
|---|
| default | null |
|---|
|
|---|
| charCounter_max | | type | |
|---|
| description | "Maximum allowed characters" |
|---|
| default | null |
|---|
|
|---|
| width | | oneOf | |
|---|
| description | "Editor width" |
|---|
| default | "100%" |
|---|
|
|---|
| minWidth | | oneOf | |
|---|
| description | "Minimum width (used when width is 'auto' or '~%')" |
|---|
| default | null |
|---|
|
|---|
| maxWidth | | oneOf | |
|---|
| description | "Maximum width (used when width is 'auto' or '~%')" |
|---|
| default | null |
|---|
|
|---|
| height | | oneOf | |
|---|
| description | "Editor height" |
|---|
| default | "auto" |
|---|
|
|---|
| minHeight | | oneOf | |
|---|
| description | "Minimum height (used when height is 'auto')" |
|---|
| default | "280px" |
|---|
|
|---|
| maxHeight | | oneOf | |
|---|
| description | "Maximum height (used when height is 'auto')" |
|---|
| default | null |
|---|
|
|---|
| editorStyle | | type | "string" |
|---|
| description | "Default CSS styles for editing area" |
|---|
| default | "" |
|---|
|
|---|
| fontSizeUnits | | type | "array" |
|---|
| description | "Allowed font size units" |
|---|
| items | | type | "string" |
|---|
| enum | | "px" |
| "pt" |
| "em" |
| "rem" |
| "vw" |
| "vh" |
| "%" |
|
|---|
|
|---|
| default | |
|---|
|
|---|
| alignItems | | type | "array" |
|---|
| description | "Alignment options (rtl-sensitive)" |
|---|
| items | | type | "string" |
|---|
| enum | | "left" |
| "center" |
| "right" |
| "justify" |
|
|---|
|
|---|
| default | | "left" |
| "center" |
| "right" |
| "justify" |
|
|---|
|
|---|
| colorList | | type | "array" |
|---|
| description | "Color list for color picker" |
|---|
| items | |
|---|
|
|---|
| lineHeights | | type | "array" |
|---|
| description | "Line height options" |
|---|
| items | | type | "object" |
|---|
| additionalProperties | false |
|---|
| properties | |
|---|
| required | |
|---|
|
|---|
|
|---|
| paragraphStyles | | type | "array" |
|---|
| description | "Custom paragraph styles" |
|---|
| items | | oneOf | |
| type | "object" |
|---|
| additionalProperties | false |
|---|
| properties | |
|---|
| required | |
|---|
|
|
|---|
|
|---|
|
|---|
| textStyles | | type | "array" |
|---|
| description | "Custom text styles" |
|---|
| items | | oneOf | |
| type | "object" |
|---|
| additionalProperties | false |
|---|
| properties | | name | |
|---|
| class | |
|---|
| style | |
|---|
| tag | | type | "string" |
|---|
| default | "span" |
|---|
|
|---|
| _class | |
|---|
|
|---|
| required | |
|---|
|
|
|---|
|
|---|
|
|---|
| imageResizing | | type | "boolean" |
|---|
| description | "Enable image resizing" |
|---|
| default | true |
|---|
|
|---|
| imageHeightShow | | type | "boolean" |
|---|
| description | "Show image height input" |
|---|
| default | true |
|---|
|
|---|
| imageAlignShow | | type | "boolean" |
|---|
| description | "Show image alignment options" |
|---|
| default | true |
|---|
|
|---|
| imageWidth | | type | "string" |
|---|
| description | "Default image width" |
|---|
| default | "auto" |
|---|
|
|---|
| imageHeight | | type | "string" |
|---|
| description | "Default image height" |
|---|
| default | "auto" |
|---|
|
|---|
| imageSizeOnlyPercentage | | type | "boolean" |
|---|
| description | "Allow only percentage scaling for images" |
|---|
| default | false |
|---|
|
|---|
| imageRotation | | type | "boolean" |
|---|
| description | "Show image rotation buttons" |
|---|
| default | true |
|---|
|
|---|
| imageFileInput | | type | "boolean" |
|---|
| description | "Show file input in image upload" |
|---|
| default | true |
|---|
|
|---|
| imageUrlInput | | type | "boolean" |
|---|
| description | "Show URL input in image upload" |
|---|
| default | true |
|---|
|
|---|
| imageUploadHeader | | type | |
|---|
| description | "HTTP headers for image upload" |
|---|
| additionalProperties | |
|---|
| default | null |
|---|
|
|---|
| imageUploadUrl | | type | |
|---|
| description | "URL for image upload endpoint" |
|---|
| default | null |
|---|
|
|---|
| imageUploadSizeLimit | | type | |
|---|
| description | "Maximum total image upload size in bytes" |
|---|
| default | null |
|---|
|
|---|
| imageMultipleFile | | type | "boolean" |
|---|
| description | "Allow multiple image selection" |
|---|
| default | false |
|---|
|
|---|
| imageAccept | | type | "string" |
|---|
| description | "Accepted image file types" |
|---|
| default | "*" |
|---|
|
|---|
| imageGalleryUrl | | type | |
|---|
| description | "URL for image gallery endpoint" |
|---|
| default | null |
|---|
|
|---|
| imageGalleryHeader | | type | |
|---|
| description | "HTTP headers for image gallery" |
|---|
| additionalProperties | |
|---|
| default | null |
|---|
|
|---|
| videoResizing | | type | "boolean" |
|---|
| description | "Enable video resizing" |
|---|
| default | true |
|---|
|
|---|
| videoHeightShow | | type | "boolean" |
|---|
| description | "Show video height input" |
|---|
| default | true |
|---|
|
|---|
| videoAlignShow | | type | "boolean" |
|---|
| description | "Show video alignment options" |
|---|
| default | true |
|---|
|
|---|
| videoRatioShow | | type | "boolean" |
|---|
| description | "Show video ratio options" |
|---|
| default | true |
|---|
|
|---|
| videoWidth | | type | "string" |
|---|
| description | "Default video width" |
|---|
| default | "100%" |
|---|
|
|---|
| videoHeight | | type | "string" |
|---|
| description | "Default video height" |
|---|
| default | "56.25%" |
|---|
|
|---|
| videoSizeOnlyPercentage | | type | "boolean" |
|---|
| description | "Allow only percentage scaling for videos" |
|---|
| default | false |
|---|
|
|---|
| videoRotation | | type | "boolean" |
|---|
| description | "Show video rotation buttons" |
|---|
| default | true |
|---|
|
|---|
| videoRatio | | type | "number" |
|---|
| description | "Default video aspect ratio (16:9 = 0.5625)" |
|---|
| default | 0.5625 |
|---|
|
|---|
| videoRatioList | | type | "array" |
|---|
| description | "Video ratio options" |
|---|
| items | | type | "object" |
|---|
| additionalProperties | false |
|---|
| properties | |
|---|
| required | |
|---|
|
|---|
|
|---|
| youtubeQuery | | type | "string" |
|---|
| description | "YouTube embed query parameters" |
|---|
| default | "" |
|---|
|
|---|
| videoFileInput | | type | "boolean" |
|---|
| description | "Show file input in video upload" |
|---|
| default | false |
|---|
|
|---|
| videoUrlInput | | type | "boolean" |
|---|
| description | "Show URL input in video upload" |
|---|
| default | true |
|---|
|
|---|
| videoUploadHeader | | type | |
|---|
| description | "HTTP headers for video upload" |
|---|
| additionalProperties | |
|---|
| default | null |
|---|
|
|---|
| videoUploadUrl | | type | |
|---|
| description | "URL for video upload endpoint" |
|---|
| default | null |
|---|
|
|---|
| videoUploadSizeLimit | | type | |
|---|
| description | "Maximum total video upload size in bytes" |
|---|
| default | null |
|---|
|
|---|
| videoMultipleFile | | type | "boolean" |
|---|
| description | "Allow multiple video selection" |
|---|
| default | false |
|---|
|
|---|
| videoTagAttrs | | type | |
|---|
| description | "Attributes for video tag" |
|---|
| additionalProperties | |
|---|
| default | null |
|---|
|
|---|
| videoIframeAttrs | | type | |
|---|
| description | "Attributes for iframe (YouTube, Vimeo)" |
|---|
| additionalProperties | |
|---|
| default | null |
|---|
|
|---|
| videoAccept | | type | "string" |
|---|
| description | "Accepted video file types" |
|---|
| default | "*" |
|---|
|
|---|
| audioWidth | | type | "string" |
|---|
| description | "Default audio width" |
|---|
| default | "300px" |
|---|
|
|---|
| audioHeight | | type | "string" |
|---|
| description | "Default audio height" |
|---|
| default | "54px" |
|---|
|
|---|
| audioFileInput | | type | "boolean" |
|---|
| description | "Show file input in audio upload" |
|---|
| default | false |
|---|
|
|---|
| audioUrlInput | | type | "boolean" |
|---|
| description | "Show URL input in audio upload" |
|---|
| default | true |
|---|
|
|---|
| audioUploadHeader | | type | |
|---|
| description | "HTTP headers for audio upload" |
|---|
| additionalProperties | |
|---|
| default | null |
|---|
|
|---|
| audioUploadUrl | | type | |
|---|
| description | "URL for audio upload endpoint" |
|---|
| default | null |
|---|
|
|---|
| audioUploadSizeLimit | | type | |
|---|
| description | "Maximum total audio upload size in bytes" |
|---|
| default | null |
|---|
|
|---|
| audioMultipleFile | | type | "boolean" |
|---|
| description | "Allow multiple audio selection" |
|---|
| default | false |
|---|
|
|---|
| audioTagAttrs | | type | |
|---|
| description | "Attributes for audio tag" |
|---|
| additionalProperties | |
|---|
| default | null |
|---|
|
|---|
| audioAccept | | type | "string" |
|---|
| description | "Accepted audio file types" |
|---|
| default | "*" |
|---|
|
|---|
| tableCellControllerPosition | | type | "string" |
|---|
| description | "Table cell controller position" |
|---|
| enum | |
|---|
| default | "cell" |
|---|
|
|---|
| linkTargetNewWindow | | type | "boolean" |
|---|
| description | "Default checked state for new window checkbox" |
|---|
| default | false |
|---|
|
|---|
| defaultUrlProtocol | | type | |
|---|
| description | "Default protocol for links" |
|---|
| default | null |
|---|
|
|---|
| linkRel | | type | "array" |
|---|
| description | "Available rel attributes for links" |
|---|
| items | |
|---|
| default | |
|---|
|
|---|
| linkRelDefault | | type | "object" |
|---|
| description | "Default rel attributes for links" |
|---|
| additionalProperties | |
|---|
| properties | | default | |
|---|
| check_new_window | |
|---|
| check_bookmark | |
|---|
|
|---|
| default | |
|---|
|
|---|
| linkNoPrefix | | type | "boolean" |
|---|
| description | "Disable automatic URL prefixing" |
|---|
| default | false |
|---|
|
|---|
| hrItems | | type | "array" |
|---|
| description | "HR style options" |
|---|
| items | | type | "object" |
|---|
| additionalProperties | false |
|---|
| properties | |
|---|
| required | |
|---|
| anyOf | |
|---|
|
|---|
|
|---|
| tabDisable | | type | "boolean" |
|---|
| description | "Disable tab key interaction" |
|---|
| default | false |
|---|
|
|---|
| shortcutsDisable | | type | "boolean" |
|---|
| description | "Disable all keyboard shortcuts" |
|---|
| default | false |
|---|
|
|---|
| shortcutsHint | | type | "boolean" |
|---|
| description | "Show shortcuts hint" |
|---|
| default | true |
|---|
|
|---|
| templates | | type | |
|---|
| description | "Template definitions" |
|---|
| items | | type | "object" |
|---|
| additionalProperties | false |
|---|
| properties | |
|---|
| required | |
|---|
|
|---|
| default | null |
|---|
|
|---|
| placeholder | | type | |
|---|
| description | "Placeholder text" |
|---|
| default | null |
|---|
|
|---|
| icons | | type | |
|---|
| description | "Custom icon definitions" |
|---|
| additionalProperties | |
|---|
| default | null |
|---|
|
|---|
| buttonList | | type | "array" |
|---|
| description | "Defines button list configuration" |
|---|
| items | | $ref | "#/definitions/buttonEntry" |
|---|
|
|---|
|
|---|