reflex 0.7.14a6__py3-none-any.whl → 0.8.0__py3-none-any.whl

reflex/components/suneditor/editor.py

@@ -1,269 +0,0 @@
-"""A Rich Text Editor based on SunEditor."""
-
-from __future__ import annotations
-
-import enum
-from typing import Any, Literal
-
-from reflex.base import Base
-from reflex.components.component import Component, NoSSRComponent
-from reflex.event import EventHandler, no_args_event_spec, passthrough_event_spec
-from reflex.utils.format import to_camel_case
-from reflex.utils.imports import ImportDict, ImportVar
-from reflex.vars.base import Var
-
-
-class EditorButtonList(list, enum.Enum):
-    """List enum that provides three predefined button lists."""
-
-    BASIC = [
-        ["font", "fontSize"],
-        ["fontColor"],
-        ["horizontalRule"],
-        ["link", "image"],
-    ]
-    FORMATTING = [
-        ["undo", "redo"],
-        ["bold", "underline", "italic", "strike", "subscript", "superscript"],
-        ["removeFormat"],
-        ["outdent", "indent"],
-        ["fullScreen", "showBlocks", "codeView"],
-        ["preview", "print"],
-    ]
-    COMPLEX = [
-        ["undo", "redo"],
-        ["font", "fontSize", "formatBlock"],
-        ["bold", "underline", "italic", "strike", "subscript", "superscript"],
-        ["removeFormat"],
-        "/",
-        ["fontColor", "hiliteColor"],
-        ["outdent", "indent"],
-        ["align", "horizontalRule", "list", "table"],
-        ["link", "image", "video"],
-        ["fullScreen", "showBlocks", "codeView"],
-        ["preview", "print"],
-        ["save", "template"],
-    ]
-
-
-class EditorOptions(Base):
-    """Some of the additional options to configure the Editor.
-    Complete list of options found here:
-    https://github.com/JiHong88/SunEditor/blob/master/README.md#options.
-    """
-
-    # Specifies default tag name of the editor.
-    # default: 'p' {String}
-    default_tag: str | None = None
-
-    # The mode of the editor ('classic', 'inline', 'balloon', 'balloon-always').
-    # default: 'classic' {String}
-    mode: str | None = None
-
-    # If true, the editor is set to RTL(Right To Left) mode.
-    # default: false {Boolean}
-    rtl: bool | None = None
-
-    # List of buttons to use in the toolbar.
-    button_list: list[list[str] | str] | None
-
-
-def on_blur_spec(e: Var, content: Var[str]) -> tuple[Var[str]]:
-    """A helper function to specify the on_blur event handler.
-
-    Args:
-        e: The event.
-        content: The content of the editor.
-
-    Returns:
-        A tuple containing the content of the editor.
-    """
-    return (content,)
-
-
-def on_paste_spec(
-    e: Var, clean_data: Var[str], max_char_count: Var[bool]
-) -> tuple[Var[str], Var[bool]]:
-    """A helper function to specify the on_paste event handler.
-
-    Args:
-        e: The event.
-        clean_data: The clean data.
-        max_char_count: The maximum character count.
-
-    Returns:
-        A tuple containing the clean data and the maximum character count.
-    """
-    return (clean_data, max_char_count)
-
-
-class Editor(NoSSRComponent):
-    """A Rich Text Editor component based on SunEditor.
-    Not every JS prop is listed here (some are not easily usable from python),
-    refer to the library docs for a complete list.
-    """
-
-    library = "suneditor-react@3.6.1"
-
-    tag = "SunEditor"
-
-    is_default = True
-
-    lib_dependencies: list[str] = ["suneditor"]
-
-    # Language of the editor.
-    # Alternatively to a string, a dict of your language can be passed to this prop.
-    # Please refer to the library docs for this.
-    # options: "en" | "da" | "de" | "es" | "fr" | "ja" | "ko" | "pt_br" |
-    # "ru" | "zh_cn" | "ro" | "pl" | "ckb" | "lv" | "se" | "ua" | "he" | "it"
-    # default: "en".
-    lang: Var[
-        Literal[
-            "en",
-            "da",
-            "de",
-            "es",
-            "fr",
-            "ja",
-            "ko",
-            "pt_br",
-            "ru",
-            "zh_cn",
-            "ro",
-            "pl",
-            "ckb",
-            "lv",
-            "se",
-            "ua",
-            "he",
-            "it",
-        ]
-        | dict
-    ]
-
-    # This is used to set the HTML form name of the editor.
-    # This means on HTML form submission,
-    # it will be submitted together with contents of the editor by the name provided.
-    name: Var[str]
-
-    # Sets the default value of the editor.
-    # This is useful if you don't want the on_change method to be called on render.
-    # If you want the on_change method to be called on render please use the set_contents prop
-    default_value: Var[str]
-
-    # Sets the width of the editor.
-    # px and percentage values are accepted, eg width="100%" or width="500px"
-    # default: 100%
-    width: Var[str]
-
-    # Sets the height of the editor.
-    # px and percentage values are accepted, eg height="100%" or height="100px"
-    height: Var[str]
-
-    # Sets the placeholder of the editor.
-    placeholder: Var[str]
-
-    # Should the editor receive focus when initialized?
-    auto_focus: Var[bool]
-
-    # Pass an EditorOptions instance to modify the behaviour of Editor even more.
-    set_options: Var[dict]
-
-    # Whether all SunEditor plugins should be loaded.
-    # default: True.
-    set_all_plugins: Var[bool]
-
-    # Set the content of the editor.
-    # Note: To set the initial contents of the editor
-    # without calling the on_change event,
-    # please use the default_value prop.
-    # set_contents is used to set the contents of the editor programmatically.
-    # You must be aware that, when the set_contents's prop changes,
-    # the on_change event is triggered.
-    set_contents: Var[str]
-
-    # Append editor content
-    append_contents: Var[str]
-
-    # Sets the default style of the editor's edit area
-    set_default_style: Var[str]
-
-    # Disable the editor
-    # default: False.
-    disable: Var[bool]
-
-    # Hide the editor
-    # default: False.
-    hide: Var[bool]
-
-    # Hide the editor toolbar
-    # default: False.
-    hide_toolbar: Var[bool]
-
-    # Disable the editor toolbar
-    # default: False.
-    disable_toolbar: Var[bool]
-
-    # Fired when the editor content changes.
-    on_change: EventHandler[passthrough_event_spec(str)]
-
-    # Fired when the something is inputted in the editor.
-    on_input: EventHandler[no_args_event_spec]
-
-    # Fired when the editor loses focus.
-    on_blur: EventHandler[on_blur_spec]
-
-    # Fired when the editor is loaded.
-    on_load: EventHandler[passthrough_event_spec(bool)]
-
-    # Fired when the editor content is copied.
-    on_copy: EventHandler[no_args_event_spec]
-
-    # Fired when the editor content is cut.
-    on_cut: EventHandler[no_args_event_spec]
-
-    # Fired when the editor content is pasted.
-    on_paste: EventHandler[on_paste_spec]
-
-    # Fired when the code view is toggled.
-    toggle_code_view: EventHandler[passthrough_event_spec(bool)]
-
-    # Fired when the full screen mode is toggled.
-    toggle_full_screen: EventHandler[passthrough_event_spec(bool)]
-
-    def add_imports(self) -> ImportDict:
-        """Add imports for the Editor component.
-
-        Returns:
-            The import dict.
-        """
-        return {
-            "": ImportVar(tag="suneditor/dist/css/suneditor.min.css", install=False)
-        }
-
-    @classmethod
-    def create(
-        cls, set_options: EditorOptions | None = None, **props: Any
-    ) -> Component:
-        """Create an instance of Editor. No children allowed.
-
-        Args:
-            set_options: Configuration object to further configure the instance.
-            **props: Any properties to be passed to the Editor
-
-        Returns:
-            An Editor instance.
-
-        Raises:
-            ValueError: If set_options is a state Var.
-        """
-        if set_options is not None:
-            if isinstance(set_options, Var):
-                msg = "EditorOptions cannot be a state Var"
-                raise ValueError(msg)
-            props["set_options"] = {
-                to_camel_case(k): v
-                for k, v in set_options.dict().items()
-                if v is not None
-            }
-        return super().create(*[], **props)

reflex/components/suneditor/editor.pyi

@@ -1,199 +0,0 @@
-"""Stub file for reflex/components/suneditor/editor.py"""
-
-# ------------------- DO NOT EDIT ----------------------
-# This file was generated by `reflex/utils/pyi_generator.py`!
-# ------------------------------------------------------
-import enum
-from collections.abc import Mapping, Sequence
-from typing import Any, Literal, overload
-
-from reflex.base import Base
-from reflex.components.component import NoSSRComponent
-from reflex.components.core.breakpoints import Breakpoints
-from reflex.event import EventType
-from reflex.utils.imports import ImportDict
-from reflex.vars.base import Var
-
-class EditorButtonList(list, enum.Enum):
-    BASIC = [["font", "fontSize"], ["fontColor"], ["horizontalRule"], ["link", "image"]]
-    FORMATTING = [
-        ["undo", "redo"],
-        ["bold", "underline", "italic", "strike", "subscript", "superscript"],
-        ["removeFormat"],
-        ["outdent", "indent"],
-        ["fullScreen", "showBlocks", "codeView"],
-        ["preview", "print"],
-    ]
-    COMPLEX = [
-        ["undo", "redo"],
-        ["font", "fontSize", "formatBlock"],
-        ["bold", "underline", "italic", "strike", "subscript", "superscript"],
-        ["removeFormat"],
-        "/",
-        ["fontColor", "hiliteColor"],
-        ["outdent", "indent"],
-        ["align", "horizontalRule", "list", "table"],
-        ["link", "image", "video"],
-        ["fullScreen", "showBlocks", "codeView"],
-        ["preview", "print"],
-        ["save", "template"],
-    ]
-
-class EditorOptions(Base):
-    default_tag: str | None
-    mode: str | None
-    rtl: bool | None
-    button_list: list[list[str] | str] | None
-
-def on_blur_spec(e: Var, content: Var[str]) -> tuple[Var[str]]: ...
-def on_paste_spec(
-    e: Var, clean_data: Var[str], max_char_count: Var[bool]
-) -> tuple[Var[str], Var[bool]]: ...
-
-class Editor(NoSSRComponent):
-    def add_imports(self) -> ImportDict: ...
-    @overload
-    @classmethod
-    def create(  # type: ignore
-        cls,
-        *children,
-        lang: Literal[
-            "ckb",
-            "da",
-            "de",
-            "en",
-            "es",
-            "fr",
-            "he",
-            "it",
-            "ja",
-            "ko",
-            "lv",
-            "pl",
-            "pt_br",
-            "ro",
-            "ru",
-            "se",
-            "ua",
-            "zh_cn",
-        ]
-        | Var[
-            Literal[
-                "ckb",
-                "da",
-                "de",
-                "en",
-                "es",
-                "fr",
-                "he",
-                "it",
-                "ja",
-                "ko",
-                "lv",
-                "pl",
-                "pt_br",
-                "ro",
-                "ru",
-                "se",
-                "ua",
-                "zh_cn",
-            ]
-            | dict
-        ]
-        | dict
-        | None = None,
-        name: Var[str] | str | None = None,
-        default_value: Var[str] | str | None = None,
-        width: Var[str] | str | None = None,
-        height: Var[str] | str | None = None,
-        placeholder: Var[str] | str | None = None,
-        auto_focus: Var[bool] | bool | None = None,
-        set_options: Var[dict] | dict | None = None,
-        set_all_plugins: Var[bool] | bool | None = None,
-        set_contents: Var[str] | str | None = None,
-        append_contents: Var[str] | str | None = None,
-        set_default_style: Var[str] | str | None = None,
-        disable: Var[bool] | bool | None = None,
-        hide: Var[bool] | bool | None = None,
-        hide_toolbar: Var[bool] | bool | None = None,
-        disable_toolbar: Var[bool] | bool | None = None,
-        style: Sequence[Mapping[str, Any]]
-        | Mapping[str, Any]
-        | Var[Mapping[str, Any]]
-        | Breakpoints
-        | None = None,
-        key: Any | None = None,
-        id: Any | None = None,
-        ref: Var | None = None,
-        class_name: Any | None = None,
-        autofocus: bool | None = None,
-        custom_attrs: dict[str, Var | Any] | None = None,
-        on_blur: EventType[()] | EventType[str] | None = None,
-        on_change: EventType[()] | EventType[str] | None = None,
-        on_click: EventType[()] | None = None,
-        on_context_menu: EventType[()] | None = None,
-        on_copy: EventType[()] | None = None,
-        on_cut: EventType[()] | None = None,
-        on_double_click: EventType[()] | None = None,
-        on_focus: EventType[()] | None = None,
-        on_input: EventType[()] | None = None,
-        on_load: EventType[()] | EventType[bool] | None = None,
-        on_mount: EventType[()] | None = None,
-        on_mouse_down: EventType[()] | None = None,
-        on_mouse_enter: EventType[()] | None = None,
-        on_mouse_leave: EventType[()] | None = None,
-        on_mouse_move: EventType[()] | None = None,
-        on_mouse_out: EventType[()] | None = None,
-        on_mouse_over: EventType[()] | None = None,
-        on_mouse_up: EventType[()] | None = None,
-        on_paste: EventType[()] | EventType[str] | EventType[str, bool] | None = None,
-        on_scroll: EventType[()] | None = None,
-        on_unmount: EventType[()] | None = None,
-        toggle_code_view: EventType[()] | EventType[bool] | None = None,
-        toggle_full_screen: EventType[()] | EventType[bool] | None = None,
-        **props,
-    ) -> Editor:
-        """Create an instance of Editor. No children allowed.
-
-        Args:
-            set_options: Configuration object to further configure the instance.
-            lang: Language of the editor.  Alternatively to a string, a dict of your language can be passed to this prop.  Please refer to the library docs for this.  options: "en" | "da" | "de" | "es" | "fr" | "ja" | "ko" | "pt_br" |  "ru" | "zh_cn" | "ro" | "pl" | "ckb" | "lv" | "se" | "ua" | "he" | "it"  default: "en".
-            name: This is used to set the HTML form name of the editor.  This means on HTML form submission,  it will be submitted together with contents of the editor by the name provided.
-            default_value: Sets the default value of the editor.  This is useful if you don't want the on_change method to be called on render.  If you want the on_change method to be called on render please use the set_contents prop
-            width: Sets the width of the editor.  px and percentage values are accepted, eg width="100%" or width="500px"  default: 100%
-            height: Sets the height of the editor.  px and percentage values are accepted, eg height="100%" or height="100px"
-            placeholder: Sets the placeholder of the editor.
-            auto_focus: Should the editor receive focus when initialized?
-            set_options: Pass an EditorOptions instance to modify the behaviour of Editor even more.
-            set_all_plugins: Whether all SunEditor plugins should be loaded.  default: True.
-            set_contents: Set the content of the editor.  Note: To set the initial contents of the editor  without calling the on_change event,  please use the default_value prop.  set_contents is used to set the contents of the editor programmatically.  You must be aware that, when the set_contents's prop changes,  the on_change event is triggered.
-            append_contents: Append editor content
-            set_default_style: Sets the default style of the editor's edit area
-            disable: Disable the editor  default: False.
-            hide: Hide the editor  default: False.
-            hide_toolbar: Hide the editor toolbar  default: False.
-            disable_toolbar: Disable the editor toolbar  default: False.
-            on_change: Fired when the editor content changes.
-            on_input: Fired when the something is inputted in the editor.
-            on_blur: Fired when the editor loses focus.
-            on_load: Fired when the editor is loaded.
-            on_copy: Fired when the editor content is copied.
-            on_cut: Fired when the editor content is cut.
-            on_paste: Fired when the editor content is pasted.
-            toggle_code_view: Fired when the code view is toggled.
-            toggle_full_screen: Fired when the full screen mode is toggled.
-            style: The style of the component.
-            key: A unique key for the component.
-            id: The id for the component.
-            ref: The Var to pass as the ref to the component.
-            class_name: The class name for the component.
-            autofocus: Whether the component should take the focus once the page is loaded
-            custom_attrs: custom attribute
-            **props: Any properties to be passed to the Editor
-
-        Returns:
-            An Editor instance.
-
-        Raises:
-            ValueError: If set_options is a state Var.
-        """