# AUTO GENERATED FILE - DO NOT EDIT import typing # noqa: F401 from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401 from dash.development.base_component import Component, _explicitize_args ComponentSingleType = typing.Union[str, int, float, Component, None] ComponentType = typing.Union[ ComponentSingleType, typing.Sequence[ComponentSingleType], ] NumberType = typing.Union[ typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex ] class FefferyRichTextEditor(Component): """A FefferyRichTextEditor component. 富文本编辑器组件FefferyRichTextEditor Keyword arguments: - id (string; optional): 组件唯一id. - key (string; optional): 对当前组件的`key`值进行更新，可实现强制重绘当前组件的效果. - className (string | dict; optional): 当前组件css类名，支持[动态css](/advanced-classname). - toolbarClassName (string; optional): 工具栏类名. - toolbarStyle (dict; optional): 设置工具栏的样式. - editorClassName (string; optional): 编辑器类名. - editorStyle (dict; optional): 设置编辑器的样式. - locale (a value equal to: 'zh-CN', 'en'; default 'zh-CN'): 组件语言，可选的有`'zh-CN'`、`'en'` 默认值：`'zh-CN'`. - mode (a value equal to: 'default', 'simple'; default 'default'): 编辑器模式，可选的有`'default'`、`'simple'`，`'default'`模式 - 集成了 wangEditor 所有功能，`'simple'`模式 - 仅有部分常见功能，但更加简洁易用默认值：`'default'`. - htmlValue (string; optional): 编辑器`html`格式内容. - textValue (string; optional): 编辑器纯文本内容. - selectionTextValue (string; optional): 编辑器选中文本内容. - toolbarConfig (dict; optional): 工具栏配置. `toolbarConfig` is a dict with keys: - toolbarKeys (list; optional): 配置工具栏显示的菜单key，默认工具栏从左至右菜单对应的key为
[
\"headerSelect\",
\"blockquote\",
\"|\",
\"bold\",
\"underline\",
\"italic\",
{
\"key\": \"group-more-style\",
\"title\": \"更多\",
\"iconSvg\": \"\",
\"menuKeys\": [
\"through\",
\"code\",
\"sup\",
\"sub\",
\"clearStyle\"
]
},
\"color\",
\"bgColor\",
\"|\",
\"fontSize\",
\"fontFamily\",
\"lineHeight\",
\"|\",
\"bulletedList\",
\"numberedList\",
\"todo\",
{
\"key\": \"group-justify\",
\"title\": \"对齐\",
\"iconSvg\": \"\",
\"menuKeys\": [
\"justifyLeft\",
\"justifyRight\",
\"justifyCenter\",
\"justifyJustify\"
]
},
{
\"key\": \"group-indent\",
\"title\": \"缩进\",
\"iconSvg\": \"\",
\"menuKeys\": [
\"indent\",
\"delIndent\"
]
},
\"|\",
\"emotion\",
\"insertLink\",
{
\"key\": \"group-image\",
\"title\": \"图片\",
\"iconSvg\": \"\",
\"menuKeys\": [
\"insertImage\",
\"uploadImage\"
]
},
{
\"key\": \"group-video\",
\"title\": \"视频\",
\"iconSvg\": \"\",
\"insertVideo\",
\"uploadVideo\"
]
},
\"insertTable\",
\"codeBlock\",
\"divider\",
\"|\",
\"undo\",
\"redo\",
\"|\",
\"fullScreen\"
]. - modalAppendToBody (boolean; optional): 是否将菜单弹出的`modal`添加到`body`下默认值：`False`. - editorConfig (dict; optional): 编辑器配置. `editorConfig` is a dict with keys: - placeholder (string; optional): 配置编辑器`placeholder`. - readOnly (boolean; optional): 配置编辑器是否只读默认值：`False`. - autoFocus (boolean; optional): 配置编辑器默认是否`focus` 默认值：`True`. - scroll (boolean; optional): 配置编辑器是否支持滚动，注意，此时不要固定`editor-container`的高度，设置一个`min-height`即可，TIP：可将`scroll`设置为`False`的情况：编辑器高度自增、在线文档，如腾讯文档、语雀那样的默认值：`True`. - maxLength (number; optional): 配置编辑器的`maxlength`，TIP：无特殊需求，请慎用`maxLength`，这可能会导致编辑器内容过多时，编辑卡顿. - MENU_CONF (dict; optional): 配置菜单. `MENU_CONF` is a dict with keys: - color (list; optional): 配置菜单文字颜色选项. - bgColor (list; optional): 配置菜单背景颜色选项. - fontSize (dict; optional): 配置菜单字号选项. `fontSize` is a dict with keys: - fontSizeList (list of dicts; optional) `fontSizeList` is a list of string Or dict with keys: - name (string; optional) - value (string; optional)s - fontFamily (dict; optional): 配置菜单字体选项. `fontFamily` is a dict with keys: - fontFamilyList (list of dicts; optional) `fontFamilyList` is a list of string Or dict with keys: - name (string; optional) - value (string; optional)s - lineHeight (dict; optional): 配置菜单行高选项. `lineHeight` is a dict with keys: - lineHeightList (list of strings; optional) - emotions (dict; optional): 配置菜单表情选项. `emotions` is a dict with keys: - emotions (list of strings; optional) - codeSelectLang (dict; optional): 配置代码高亮. `codeSelectLang` is a dict with keys: - codeLangs (list of dicts; optional): 配置代码语言，可用的有：
[
{
\"text\": \"CSS\",
\"value\": \"css\"
},
{
\"text\": \"HTML\",
\"value\": \"html\"
},
{
\"text\": \"XML\",
\"value\": \"xml\"
},
{
\"text\": \"Javascript\",
\"value\": \"javascript\"
},
{
\"text\": \"Typescript\",
\"value\": \"typescript\"
},
{
\"text\": \"JSX\",
\"value\": \"jsx\"
},
{
\"text\": \"Go\",
\"value\": \"go\"
},
{
\"text\": \"PHP\",
\"value\": \"php\"
},
{
\"text\": \"C\",
\"value\": \"c\"
},
{
\"text\": \"Python\",
\"value\": \"python\"
},
{
\"text\": \"Java\",
\"value\": \"java\"
},
{
\"text\": \"C++\",
\"value\": \"cpp\"
},
{
\"text\": \"C#\",
\"value\": \"csharp\"
},
{
\"text\": \"Visual Basic\",
\"value\": \"visual-basic\"
},
{
\"text\": \"SQL\",
\"value\": \"sql\"
},
{
\"text\": \"Ruby\",
\"value\": \"ruby\"
},
{
\"text\": \"Swift\",
\"value\": \"swift\"
},
{
\"text\": \"Bash\",
\"value\": \"bash\"
},
{
\"text\": \"Lua\",
\"value\": \"lua\"
},
{
\"text\": \"Groovy\",
\"value\": \"groovy\"
},
{
\"text\": \"Markdown\",
\"value\": \"markdown\"
}
]. `codeLangs` is a list of dicts with keys: - text (string; optional) - value (string; optional) - uploadImage (dict; optional): 配置菜单图片上传. `uploadImage` is a dict with keys: - server (string; optional): 配置上传的服务端地址，服务端`response body`格式要求如下：
上传成功的返回格式：
{
\"errno\": 0, // 注意：值是数字，不能是字符串
\"data\": {
\"url\": \"xxx\", // 图片 src ，必须
\"alt\": \"yyy\", // 图片描述文字，非必须
\"href\": \"zzz\" // 图片的链接，非必须
}
}
上传失败的返回格式：
{
\"errno\": 1, // 只要不等于 0 就行
\"message\": \"失败信息\"
}. - fieldName (string; optional): 配置上传的`form-data fieldName` 默认值：`'wangeditor-uploaded-image'`. - maxFileSize (number; optional): 配置单个文件的最大体积限制，单位为`B` 默认值：`2 * 1024 * 1024`. - maxNumberOfFiles (number; optional): 配置最多可上传几个文件默认值：`100`. - allowedFileTypes (list; optional): 配置选择文件时的类型限制，默认为`['image/*']`，如不想限制，则设置为`[]`. - meta (dict; optional): 配置自定义上传参数，例如传递验证的`token`等，参数会被添加到`formData`中，一起上传到服务端. - metaWithUrl (boolean; optional): 配置是否将`meta`拼接到`url`参数中默认`False`. - headers (dict; optional): 配置自定义增加`http header`. - withCredentials (boolean; optional): 配置跨域是否传递`cookie` 默认值：`False`. - timeout (number; optional): 配置超时时间，单位：秒默认值：`10`. - base64LimitSize (number; optional): 配置小于该值就插入`base64`格式（而不上传）默认值：`0`. - uploadVideo (dict; optional): 配置菜单视频上传. `uploadVideo` is a dict with keys: - server (string; optional): 配置上传的服务端地址，服务端`response body`格式要求如下：
上传成功的返回格式：
{
\"errno\": 0, // 注意：值是数字，不能是字符串
\"data\": {
\"url\": \"xxx\", // 视频 src ，必须
\"poster\": \"xxx.png\" // 视频封面图片 url ，可选
}
}
上传失败的返回格式：
{
\"errno\": 1, // 只要不等于 0 就行
\"message\": \"失败信息\"
}
. - fieldName (string; optional): 配置上传的`form-data fieldName` 默认值：`'wangeditor-uploaded-video'`. - maxFileSize (number; optional): 配置单个文件的最大体积限制，单位为`B` 默认值：`10 * 1024 * 1024`. - maxNumberOfFiles (number; optional): 配置最多可上传几个文件默认值：`5`. - allowedFileTypes (list; optional): 选择文件时的类型限制，默认为`['video/*']`，如不想限制，则设置为`[]`. - meta (dict; optional): 配置自定义上传参数，例如传递验证的`token`等，参数会被添加到`formData`中，一起上传到服务端. - metaWithUrl (boolean; optional): 配置是否将`meta`拼接到`url`参数中默认`False`. - headers (dict; optional): 配置自定义增加`http header`. - withCredentials (boolean; optional): 配置跨域是否传递`cookie` 默认值：`False`. - timeout (number; optional): 配置超时时间，单位：秒默认值：`10`. - successMessage (dict; optional): 成功的消息提示配置. `successMessage` is a dict with keys: - className (string; optional): 设置消息的`css`类名. - style (dict; optional): 设置消息的`css`样式. - duration (number; optional): 设置消息提示显示时长（单位：毫秒）默认值：`4000`. - icon (a list of or a singular dash component, string or number; optional): 自定义消息提示图标. - position (a value equal to: 'top-left', 'top-center', 'top-right', 'bottom-left', 'bottom-center', 'bottom-right'; optional): 设置消息提示的弹出方位，可选的有`'top-left'`、`'top-center'`、`'top-right'`、`'bottom-left'`、`'bottom-center'`、`'bottom-right'` 默认值：`'top-center'`. - errorMessage (dict; optional): 错误的消息提示配置. `errorMessage` is a dict with keys: - className (string; optional): 设置消息的`css`类名. - style (dict; optional): 设置消息的`css`样式. - duration (number; optional): 设置消息提示显示时长（单位：毫秒）默认值：`4000`. - icon (a list of or a singular dash component, string or number; optional): 自定义消息提示图标. - position (a value equal to: 'top-left', 'top-center', 'top-right', 'bottom-left', 'bottom-center', 'bottom-right'; optional): 设置消息提示的弹出方位，可选的有`'top-left'`、`'top-center'`、`'top-right'`、`'bottom-left'`、`'bottom-center'`、`'bottom-right'` 默认值：`'top-center'`.""" _children_props: typing.List[str] = ['successMessage.icon', 'errorMessage.icon'] _base_nodes = ['children'] _namespace = 'feffery_utils_components' _type = 'FefferyRichTextEditor' ToolbarConfig = TypedDict( "ToolbarConfig", { "toolbarKeys": NotRequired[typing.Sequence], "modalAppendToBody": NotRequired[bool] } ) EditorConfig_MENU_CONFFontSizeFontSizeList = TypedDict( "EditorConfig_MENU_CONFFontSizeFontSizeList", { "name": NotRequired[str], "value": NotRequired[str] } ) EditorConfig_MENU_CONFFontSize = TypedDict( "EditorConfig_MENU_CONFFontSize", { "fontSizeList": NotRequired[typing.Sequence[typing.Union[str, "EditorConfig_MENU_CONFFontSizeFontSizeList"]]] } ) EditorConfig_MENU_CONFFontFamilyFontFamilyList = TypedDict( "EditorConfig_MENU_CONFFontFamilyFontFamilyList", { "name": NotRequired[str], "value": NotRequired[str] } ) EditorConfig_MENU_CONFFontFamily = TypedDict( "EditorConfig_MENU_CONFFontFamily", { "fontFamilyList": NotRequired[typing.Sequence[typing.Union[str, "EditorConfig_MENU_CONFFontFamilyFontFamilyList"]]] } ) EditorConfig_MENU_CONFLineHeight = TypedDict( "EditorConfig_MENU_CONFLineHeight", { "lineHeightList": NotRequired[typing.Sequence[str]] } ) EditorConfig_MENU_CONFEmotions = TypedDict( "EditorConfig_MENU_CONFEmotions", { "emotions": NotRequired[typing.Sequence[str]] } ) EditorConfig_MENU_CONFCodeSelectLangCodeLangs = TypedDict( "EditorConfig_MENU_CONFCodeSelectLangCodeLangs", { "text": NotRequired[str], "value": NotRequired[str] } ) EditorConfig_MENU_CONFCodeSelectLang = TypedDict( "EditorConfig_MENU_CONFCodeSelectLang", { "codeLangs": NotRequired[typing.Sequence["EditorConfig_MENU_CONFCodeSelectLangCodeLangs"]] } ) EditorConfig_MENU_CONF = TypedDict( "EditorConfig_MENU_CONF", { "color": NotRequired[typing.Sequence], "bgColor": NotRequired[typing.Sequence], "fontSize": NotRequired["EditorConfig_MENU_CONFFontSize"], "fontFamily": NotRequired["EditorConfig_MENU_CONFFontFamily"], "lineHeight": NotRequired["EditorConfig_MENU_CONFLineHeight"], "emotions": NotRequired["EditorConfig_MENU_CONFEmotions"], "codeSelectLang": NotRequired["EditorConfig_MENU_CONFCodeSelectLang"] } ) EditorConfig = TypedDict( "EditorConfig", { "placeholder": NotRequired[str], "readOnly": NotRequired[bool], "autoFocus": NotRequired[bool], "scroll": NotRequired[bool], "maxLength": NotRequired[NumberType], "MENU_CONF": NotRequired["EditorConfig_MENU_CONF"] } ) UploadImage = TypedDict( "UploadImage", { "server": NotRequired[str], "fieldName": NotRequired[str], "maxFileSize": NotRequired[NumberType], "maxNumberOfFiles": NotRequired[NumberType], "allowedFileTypes": NotRequired[typing.Sequence], "meta": NotRequired[dict], "metaWithUrl": NotRequired[bool], "headers": NotRequired[dict], "withCredentials": NotRequired[bool], "timeout": NotRequired[NumberType], "base64LimitSize": NotRequired[NumberType] } ) UploadVideo = TypedDict( "UploadVideo", { "server": NotRequired[str], "fieldName": NotRequired[str], "maxFileSize": NotRequired[NumberType], "maxNumberOfFiles": NotRequired[NumberType], "allowedFileTypes": NotRequired[typing.Sequence], "meta": NotRequired[dict], "metaWithUrl": NotRequired[bool], "headers": NotRequired[dict], "withCredentials": NotRequired[bool], "timeout": NotRequired[NumberType] } ) SuccessMessage = TypedDict( "SuccessMessage", { "className": NotRequired[str], "style": NotRequired[dict], "duration": NotRequired[NumberType], "icon": NotRequired[ComponentType], "position": NotRequired[Literal["top-left", "top-center", "top-right", "bottom-left", "bottom-center", "bottom-right"]] } ) ErrorMessage = TypedDict( "ErrorMessage", { "className": NotRequired[str], "style": NotRequired[dict], "duration": NotRequired[NumberType], "icon": NotRequired[ComponentType], "position": NotRequired[Literal["top-left", "top-center", "top-right", "bottom-left", "bottom-center", "bottom-right"]] } ) def __init__( self, id: typing.Optional[typing.Union[str, dict]] = None, key: typing.Optional[str] = None, style: typing.Optional[typing.Any] = None, className: typing.Optional[typing.Union[str, dict]] = None, toolbarClassName: typing.Optional[str] = None, toolbarStyle: typing.Optional[dict] = None, editorClassName: typing.Optional[str] = None, editorStyle: typing.Optional[dict] = None, locale: typing.Optional[Literal["zh-CN", "en"]] = None, mode: typing.Optional[Literal["default", "simple"]] = None, htmlValue: typing.Optional[str] = None, textValue: typing.Optional[str] = None, selectionTextValue: typing.Optional[str] = None, toolbarConfig: typing.Optional["ToolbarConfig"] = None, editorConfig: typing.Optional["EditorConfig"] = None, uploadImage: typing.Optional["UploadImage"] = None, uploadVideo: typing.Optional["UploadVideo"] = None, successMessage: typing.Optional["SuccessMessage"] = None, errorMessage: typing.Optional["ErrorMessage"] = None, **kwargs ): self._prop_names = ['id', 'key', 'style', 'className', 'toolbarClassName', 'toolbarStyle', 'editorClassName', 'editorStyle', 'locale', 'mode', 'htmlValue', 'textValue', 'selectionTextValue', 'toolbarConfig', 'editorConfig', 'uploadImage', 'uploadVideo', 'successMessage', 'errorMessage'] self._valid_wildcard_attributes = [] self.available_properties = ['id', 'key', 'style', 'className', 'toolbarClassName', 'toolbarStyle', 'editorClassName', 'editorStyle', 'locale', 'mode', 'htmlValue', 'textValue', 'selectionTextValue', 'toolbarConfig', 'editorConfig', 'uploadImage', 'uploadVideo', 'successMessage', 'errorMessage'] self.available_wildcard_properties = [] _explicit_args = kwargs.pop('_explicit_args') _locals = locals() _locals.update(kwargs) # For wildcard attrs and excess named props args = {k: _locals[k] for k in _explicit_args} super(FefferyRichTextEditor, self).__init__(**args) setattr(FefferyRichTextEditor, "__init__", _explicitize_args(FefferyRichTextEditor.__init__))