Jump to content

JsonSchema:SchemaBuilder/SunEditorOptions

From Wikiyouth
$schema"http://json-schema.org/draft-07/schema#"
$id"https://wikisphere.org/wiki/JsonSchema:SchemaBuilder/SunEditorOptions"
title"SunEditor Options"
description"Reference: [https://suneditor.com/options https://suneditor.com/options]"
x-description-format"wikitext"
@comment"Schema for SunEditor rich text editor configuration options"
x-layout"paged"
x-layout-config
navigationfalse
type"object"
additionalPropertiestrue
x-default-properties
"height"
"minHeight"
definitions
buttonName
type"string"
enum
"undo"
"redo"
"bold"
"italic"
"underline"
"strike"
"blockStyle"
"font"
"fontSize"
"fontColor"
"backgroundColor"
"removeFormat"
"outdent"
"indent"
"align"
"list"
"table"
"link"
"image"
"video"
"fullScreen"
"codeView"
"subscript"
"superscript"
"preview"
"print"
"save"
"template"
"layout"
"lineHeight"
"paragraphStyle"
"textStyle"
"blockquote"
"hr"
"showBlocks"
"markdownView"
"dir_ltr"
"dir_rtl"
"copy"
"cut"
"paste"
"selectAll"
"newDocument"
"pageBreak"
"pageUp"
"pageDown"
"pageNavigator"
"finder"
"/"
"-left"
"-right"
"#fix"
":Format-default.more_paragraph"
":Text-default.more_text"
":Insert-default.more_plus"
buttonGroup
type"array"
items
$ref"#/definitions/buttonName"
buttonEntry
anyOf
$ref"#/definitions/buttonGroup"
$ref"#/definitions/buttonName"
type"string"
pattern"^%[0-9]{3,4}$"
type"array"
minItems2
maxItems2
additionalItemsfalse
items
type"string"
pattern"^%[0-9]{3,4}$"
type"array"
items
anyOf
$ref"#/definitions/buttonGroup"
$ref"#/definitions/buttonName"
properties
defaultTag
type"string"
description"Default tag name for the editor"
default"p"
convertTextTags
type"object"
description"Custom tags for text formatting buttons"
additionalProperties
type"string"
properties
bold
type"string"
default"STRONG"
underline
type"string"
default"U"
italic
type"string"
default"EM"
strike
type"string"
default"DEL"
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"
default400
elementWhitelist
type"string"
description"Additional tags to whitelist"
default""
elementBlacklist
type
"string"
"null"
description"Tags to blacklist"
defaultnull
attributeWhitelist
type
"object"
"null"
description"Attributes whitelist to keep in editor"
additionalProperties
type"string"
defaultnull
attributeBlacklist
type
"object"
"null"
description"Attributes blacklist to remove from editor"
additionalProperties
type"string"
defaultnull
mode
type"string"
description"Editor mode"
enum
"classic"
"inline"
"balloon"
"balloon-always"
default"classic"
rtl
type"boolean"
description"Right to Left mode"
defaultfalse
lineAttrReset
type"string"
description"Attributes to delete at line break"
default""
toolbar_width
oneOf
type"string"
type"number"
description"Width of toolbar for inline/balloon modes"
default"auto"
toolbar_container
oneOf
type"string"
type"null"
description"Custom container for toolbar"
defaultnull
toolbar_sticky
oneOf
type"number"
type"string"
type"boolean"
type"null"
description"Top offset for sticky toolbar (-1, false, or null to turn off)"
default0
toolbar_hide
type"boolean"
description"Hide the toolbar"
defaultfalse
fullScreenOffset
oneOf
type"number"
type"string"
description"Top offset for fullscreen mode"
default0
iframe
type"boolean"
description"Use iframe to isolate content"
defaultfalse
iframe_fullPage
type"boolean"
description"Allow HTML, HEAD, BODY tags and DOCTYPE"
defaultfalse
iframe_attributes
type
"object"
"null"
description"Attributes for iframe element"
additionalProperties
type"string"
defaultnull
iframe_cssFileName
oneOf
type"string"
type"array"
items
type"string"
description"CSS filename for iframe"
default"suneditor"
previewTemplate
type
"string"
"null"
description"Template for preview (use {{contents}} placeholder)"
defaultnull
printTemplate
type
"string"
"null"
description"Template for print (use {{contents}} placeholder)"
defaultnull
externalLibs
type"object"
description"External library configurations (codeMirror, katex, mathjax)"
additionalPropertiestrue
properties
codeMirror
oneOf
type"object"
additionalPropertiestrue
properties
options
type"object"
additionalPropertiestrue
properties
mode
type"string"
default"htmlmixed"
htmlMode
type"boolean"
defaulttrue
lineNumbers
type"boolean"
defaulttrue
lineWrapping
type"boolean"
defaulttrue
type"null"
description"CodeMirror configuration for code view (src must be a CodeMirror constructor — not representable in JSON)"
katex
oneOf
type"object"
additionalPropertiestrue
properties
options
type"object"
additionalPropertiestrue
properties
throwOnError
type"boolean"
defaultfalse
type"null"
description"KaTeX configuration for math plugin (src must be a KaTeX constructor — not representable in JSON)"
default
Empty object
statusbar
type"boolean"
description"Show status bar"
defaulttrue
statusbar_showPathLabel
type"boolean"
description"Show node structure in status bar"
defaulttrue
statusbar_resizeEnable
type"boolean"
description"Enable resizing"
defaulttrue
statusbar_container
oneOf
type"string"
type"null"
description"Custom container for status bar"
defaultnull
charCounter
type"boolean"
description"Show character counter (auto-enabled if charCounter_max is set)"
defaultfalse
charCounter_type
type"string"
description"Character counting method"
enum
"char"
"byte"
"byte-html"
default"char"
charCounter_label
type
"string"
"null"
description"Label for character counter"
defaultnull
charCounter_max
type
"number"
"null"
description"Maximum allowed characters"
defaultnull
width
oneOf
type"number"
type"string"
description"Editor width"
default"100%"
minWidth
oneOf
type"number"
type"string"
type"null"
description"Minimum width (used when width is 'auto' or '~%')"
defaultnull
maxWidth
oneOf
type"number"
type"string"
type"null"
description"Maximum width (used when width is 'auto' or '~%')"
defaultnull
height
oneOf
type"number"
type"string"
description"Editor height"
default"auto"
minHeight
oneOf
type"number"
type"string"
type"null"
description"Minimum height (used when height is 'auto')"
default"280px"
maxHeight
oneOf
type"number"
type"string"
type"null"
description"Maximum height (used when height is 'auto')"
defaultnull
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
"px"
"pt"
"em"
"rem"
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
oneOf
type"string"
type"array"
items
type"string"
lineHeights
type"array"
description"Line height options"
items
type"object"
additionalPropertiesfalse
properties
text
type"string"
value
oneOf
type"number"
type"string"
required
"value"
paragraphStyles
type"array"
description"Custom paragraph styles"
items
oneOf
type"string"
type"object"
additionalPropertiesfalse
properties
name
type"string"
class
type"string"
_class
type"string"
required
"name"
textStyles
type"array"
description"Custom text styles"
items
oneOf
type"string"
type"object"
additionalPropertiesfalse
properties
name
type"string"
class
type"string"
style
type"string"
tag
type"string"
default"span"
_class
type"string"
required
"name"
imageResizing
type"boolean"
description"Enable image resizing"
defaulttrue
imageHeightShow
type"boolean"
description"Show image height input"
defaulttrue
imageAlignShow
type"boolean"
description"Show image alignment options"
defaulttrue
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"
defaultfalse
imageRotation
type"boolean"
description"Show image rotation buttons"
defaulttrue
imageFileInput
type"boolean"
description"Show file input in image upload"
defaulttrue
imageUrlInput
type"boolean"
description"Show URL input in image upload"
defaulttrue
imageUploadHeader
type
"object"
"null"
description"HTTP headers for image upload"
additionalProperties
type"string"
defaultnull
imageUploadUrl
type
"string"
"null"
description"URL for image upload endpoint"
defaultnull
imageUploadSizeLimit
type
"number"
"null"
description"Maximum total image upload size in bytes"
defaultnull
imageMultipleFile
type"boolean"
description"Allow multiple image selection"
defaultfalse
imageAccept
type"string"
description"Accepted image file types"
default"*"
imageGalleryUrl
type
"string"
"null"
description"URL for image gallery endpoint"
defaultnull
imageGalleryHeader
type
"object"
"null"
description"HTTP headers for image gallery"
additionalProperties
type"string"
defaultnull
videoResizing
type"boolean"
description"Enable video resizing"
defaulttrue
videoHeightShow
type"boolean"
description"Show video height input"
defaulttrue
videoAlignShow
type"boolean"
description"Show video alignment options"
defaulttrue
videoRatioShow
type"boolean"
description"Show video ratio options"
defaulttrue
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"
defaultfalse
videoRotation
type"boolean"
description"Show video rotation buttons"
defaulttrue
videoRatio
type"number"
description"Default video aspect ratio (16:9 = 0.5625)"
default0.5625
videoRatioList
type"array"
description"Video ratio options"
items
type"object"
additionalPropertiesfalse
properties
name
type"string"
value
type"number"
required
"name"
"value"
youtubeQuery
type"string"
description"YouTube embed query parameters"
default""
videoFileInput
type"boolean"
description"Show file input in video upload"
defaultfalse
videoUrlInput
type"boolean"
description"Show URL input in video upload"
defaulttrue
videoUploadHeader
type
"object"
"null"
description"HTTP headers for video upload"
additionalProperties
type"string"
defaultnull
videoUploadUrl
type
"string"
"null"
description"URL for video upload endpoint"
defaultnull
videoUploadSizeLimit
type
"number"
"null"
description"Maximum total video upload size in bytes"
defaultnull
videoMultipleFile
type"boolean"
description"Allow multiple video selection"
defaultfalse
videoTagAttrs
type
"object"
"null"
description"Attributes for video tag"
additionalProperties
type"string"
defaultnull
videoIframeAttrs
type
"object"
"null"
description"Attributes for iframe (YouTube, Vimeo)"
additionalProperties
type"string"
defaultnull
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"
defaultfalse
audioUrlInput
type"boolean"
description"Show URL input in audio upload"
defaulttrue
audioUploadHeader
type
"object"
"null"
description"HTTP headers for audio upload"
additionalProperties
type"string"
defaultnull
audioUploadUrl
type
"string"
"null"
description"URL for audio upload endpoint"
defaultnull
audioUploadSizeLimit
type
"number"
"null"
description"Maximum total audio upload size in bytes"
defaultnull
audioMultipleFile
type"boolean"
description"Allow multiple audio selection"
defaultfalse
audioTagAttrs
type
"object"
"null"
description"Attributes for audio tag"
additionalProperties
type"string"
defaultnull
audioAccept
type"string"
description"Accepted audio file types"
default"*"
tableCellControllerPosition
type"string"
description"Table cell controller position"
enum
"cell"
"top"
default"cell"
linkTargetNewWindow
type"boolean"
description"Default checked state for new window checkbox"
defaultfalse
defaultUrlProtocol
type
"string"
"null"
description"Default protocol for links"
defaultnull
linkRel
type"array"
description"Available rel attributes for links"
items
type"string"
default
Empty array
linkRelDefault
type"object"
description"Default rel attributes for links"
additionalProperties
type"string"
properties
default
type"string"
check_new_window
type"string"
check_bookmark
type"string"
default
Empty object
linkNoPrefix
type"boolean"
description"Disable automatic URL prefixing"
defaultfalse
hrItems
type"array"
description"HR style options"
items
type"object"
additionalPropertiesfalse
properties
name
type"string"
class
type"string"
style
type"string"
required
"name"
anyOf
required
"class"
required
"style"
tabDisable
type"boolean"
description"Disable tab key interaction"
defaultfalse
shortcutsDisable
type"boolean"
description"Disable all keyboard shortcuts"
defaultfalse
shortcutsHint
type"boolean"
description"Show shortcuts hint"
defaulttrue
templates
type
"array"
"null"
description"Template definitions"
items
type"object"
additionalPropertiesfalse
properties
name
type"string"
html
type"string"
required
"name"
"html"
defaultnull
placeholder
type
"string"
"null"
description"Placeholder text"
defaultnull
icons
type
"object"
"null"
description"Custom icon definitions"
additionalProperties
type"string"
defaultnull
buttonList
type"array"
description"Defines button list configuration"
items
$ref"#/definitions/buttonEntry"