suneditor 2.46.2 → 3.0.0-alpha.2

package/src/options.d.ts

@@ -1,608 +0,0 @@
-import { Lang } from './lang/Lang';
-import { Plugin } from './plugins/Plugin';
-
-export interface SunEditorOptions {
-    plugins?: Plugin[] | Record<string, Plugin>;
-    /**
-     * Values
-     * ======
-     */
-    /**
-     * language object
-     */
-    lang?: Lang;
-    /**
-     * Specifies default tag name of the editor. (default: "p")
-     */
-    defaultTag?: string;
-    /**
-     * You can change the tag of the default text button.   default: { bold: 'STRONG', underline: 'U', italic: 'EM', strike: 'DEL', sub: 'SUB', sup: 'SUP' }
-     */
-    textTags?: { bold?: string; underline?: string; italic?: string; strike?: string; sub?: string; sup?: string;};
-    /**
-     * Initial value(html string) of the edit area.
-     * If not, the value of the "target textarea".
-     */
-    value?: string;
-    /**
-     * When recording the history stack, this is the delay time (miliseconds) since the last input. default: 400
-     */
-    historyStackDelayTime?: number;
-    /**
-     * Whitelist
-     * ======
-     */
-    /**
-     * Add tags to the default tags whitelist of editor.
-     */
-    addTagsWhitelist?: string | '*';
-    /**
-     * Blacklist of the editor default tags.
-     */
-    tagsBlacklist?: string;
-    /**
-     * Whitelist of tags when pasting.
-     */
-    pasteTagsWhitelist?: string | '*';
-    /**
-     * Blacklist of tags when pasting.
-     */
-    pasteTagsBlacklist?: string;
-    /**
-     * Add attributes whitelist of tags that should be kept undeleted from the editor.
-     */
-    attributesWhitelist?: Record<string, string | '*'>;
-    /**
-     * Add attribute blacklist of tags that should be deleted in editor.
-     */
-    attributesBlacklist?: Record<string, string | '*'>;
-    /**
-     * Layout
-     * ======
-     */
-    /**
-     * The mode of the editor (classic, inline, balloon, balloon-always)
-     */
-    mode?: 'classic' | 'inline' | 'balloon' | 'balloon-always';
-    /**
-     * If true, the editor is set to RTL(Right To Left) mode.
-     */
-    rtl?: boolean;
-    /**
-     * Deletes other attributes except for the property set at the time of line break.
-     * If there is no value, no all attribute is deleted.
-     * @example 'class|style': Attributes other than "class" and "style" are deleted at line break.
-     * '*': All attributes are deleted at line break.
-     */
-    lineAttrReset?: string;
-    /**
-     * Button List
-     */
-    buttonList?: ButtonListItem[];
-    /**
-     * The width of the toolbar.
-     Applies only when the editor mode is 'inline' or 'balloon' mode.
-     */
-    toolbarWidth?: string;
-    /**
-     * A custom HTML selector placing the toolbar inside.
-     The class name of the element must be 'sun-editor'.
-     Element or querySelector argument.
-     */
-    toolbarContainer?: HTMLElement | string;
-    /**
-     * Top offset value of "sticky toolbar".
-     */
-    stickyToolbar?: number | string;
-    /**
-     * The toolbar is rendered hidden.
-     */
-    hideToolbar?: boolean;
-    /**
-     * Top offset value of "full Screen".
-     */
-    fullScreenOffset?: number | string;
-    /**
-     * Content will be placed in an iframe and isolated from the rest of the page
-     */
-    iframe?: boolean;
-    /**
-     * Allows the usage of HTML, HEAD, BODY tags and DOCTYPE declaration
-     */
-    fullPage?: boolean;
-    /**
-     * Attributes of the iframe.
-     */
-    iframeAttributes?: Record<string, string>;
-    /**
-     * Name of the CSS file(s) to apply inside the iframe.
-     */
-    iframeCSSFileName?: string | string[];
-    /**
-     * A template of the "preview".
-     * The {{contents}} part in the HTML string is replaced with the contents of the editor.
-     * @example "<h1>Preview Template</h1> {{contents}} <div>_Footer_</div>"
-     */
-    previewTemplate?: string;
-    /**
-     * A template of the "print".
-     * The {{contents}} part in the HTML string is replaced with the contents of the editor.
-     * @example "<h1>Print Template</h1> {{contents}} <div>_Footer_</div>"
-     */
-    printTemplate?: string;
-    /**
-     * CodeMirror object
-     */
-    codeMirror?: any | { src: any; options: object };
-    /**
-     * Katex object (Use "math" plugin)
-     */
-    katex?: any | { src: any; options: object };
-    /**
-     * Math plugin font size list 
-     */
-    mathFontSize?: { text: string; value: string; default?: boolean; }[];
-    /**
-     * Display
-     * =======
-     */
-    /**
-     * The position property of editor
-     */
-    position?: string;
-    /**
-     * The display property of editor
-     */
-    display?: string;
-    /**
-     * Size of background area when activating dialog window ('full'||'local')
-     */
-    popupDisplay?: 'full' | 'local';
-    /**
-     * Bottom resizing bar
-     * ===================
-     */
-    /**
-     * Show the bottom resizing bar
-     */
-    resizingBar?: boolean;
-    /**
-     * Displays the current node structure to resizingBar
-     */
-    showPathLabel?: boolean;
-    /**
-     * Enable/disable resize function of bottom resizing bar.
-     */
-    resizeEnable?: boolean;
-    /**
-     * A custom HTML selector placing the resizing bar inside.
-     The class name of the element must be 'sun-editor'.
-     Element or querySelector argument.
-     */
-    resizingBarContainer?: HTMLElement | string;
-    /**
-     * Character count
-     * ===============
-     */
-    /**
-     * Shows the number of characters in the editor
-     */
-    charCounter?: boolean;
-    /**
-     * Defines the calculation method of the "charCounter" option
-     */
-    charCounterType?: 'char' | 'byte' | 'byte-html';
-    /**
-     * Text to be displayed in the "charCounter" area of the bottom bar.
-     */
-    charCounterLabel?: string;
-    /**
-     * The maximum number of characters allowed to be inserted into the editor
-     */
-    maxCharCount?: number;
-    /**
-     * Size
-     * ====
-     */
-    /**
-     * The width size of the editor
-     */
-    width?: string;
-    /**
-     * The min-width size of the editor
-     */
-    minWidth?: string;
-    /**
-     * The max-width size of the editor
-     */
-    maxWidth?: string;
-    /**
-     * The height size of the editor
-     */
-    height?: string;
-    /**
-     * The min-height size of the editor
-     */
-    minHeight?: string;
-    /**
-     * The max-height size of the editor
-     */
-    maxHeight?: string;
-    /** 
-     * Editing area
-     * ===================
-    */
-    /**
-     * Add a "class" to the editing area[.sun-editor-editable]
-     */
-    className?: string;
-    /**
-     * You can define the style of the editing area[.sun-editor-editable].
-     * It affects the entire editing area.
-     * ('z-index', 'position' and 'width' properties apply to the top div.)
-     * @example 'font-family: cursive; font-size: 10px;'
-     */
-    defaultStyle?: string;
-    /**
-     * Defining menu items
-     * ===================
-     */
-    /**
-     * Change default font-family array
-     */
-    font?: string[];
-    /**
-     * Change default font-size array
-     */
-    fontSize?: number[];
-    /**
-     * The font size unit
-     */
-    fontSizeUnit?: string;
-    /**
-     * A list of drop-down options for the 'align' plugin.
-     */
-    alignItems?: ('left' | 'center' | 'right' | 'justify')[];
-    /**
-     * Change default formatBlock array
-     */
-    formats?: FormatTagName[];
-    /**
-     * Change default color array of color picker
-     */
-    colorList?: string[];
-    /**
-     * Line Heights
-     */
-    lineHeights?: LineHeightsItem[];
-    /**
-     * Paragraph Styles
-     */
-    paragraphStyles?: ParagraphStyles;
-    /**
-     * Text Styles
-     */
-    textStyles?: TextStyles;
-    /**
-     * Image
-     * =====
-     */
-    /**
-     * Can resize the image
-     */
-    imageResizing?: boolean;
-    /**
-     * Choose whether the image height input is visible.
-     */
-    imageHeightShow?: boolean;
-    /**
-     * Choose whether the image align radio buttons are visible.
-     */
-    imageAlignShow?: boolean;
-    /**
-     * The default width size of the image frame
-     */
-    imageWidth?: string;
-    /**
-     * The default height size of the image frame
-     */
-    imageHeight?: string;
-    /**
-     * If true, image size can only be scaled by percentage.
-     */
-    imageSizeOnlyPercentage?: boolean;
-    /**
-     * It is determined by "imageSizeOnlyPercentage".
-     * @pivate
-     */
-    _videoSizeUnit?: '%' | 'px';
-    /**
-     * Choose whether to image rotation buttons display.
-     * When "imageSizeOnlyPercentage" is "true" or  or "imageHeightShow" is "false" the default value is false.
-     * If you want the button to be visible, put it a true.
-     */
-    imageRotation?: boolean;
-    /**
-     * Choose whether to create a file input tag in the image upload window
-     */
-    imageFileInput?: boolean;
-    /**
-     * Choose whether to create a image url input tag in the image upload window
-     */
-    imageUrlInput?: boolean;
-    /**
-     * Http Header when uploading images.
-     */
-    imageUploadHeader?: Record<string, string>;
-    /**
-     * The image upload to server mapping address
-     */
-    imageUploadUrl?: string;
-    /**
-     * The size of the total uploadable images (in bytes)
-     */
-    imageUploadSizeLimit?: number;
-    /**
-     * If true, multiple images can be selected.
-     */
-    imageMultipleFile?: boolean;
-    /**
-     * Define the "accept" attribute of the input.
-     * @example "*" or ".jpg, .png .."
-     */
-    imageAccept?: string;               
-    /**
-     * Image - image gallery
-     * =====
-     */
-    /**
-     * The url of the image gallery, if you use the image gallery
-     */
-    imageGalleryUrl?: string;
-    /**
-     * Http Header when get image gallery.
-     */
-    imageGalleryHeader?: Record<string, string>;
-    /**
-     * Video
-     * =====
-     */
-    /**
-     * Can resize the video iframe
-     */
-    videoResizing?: boolean;
-    /**
-     * Choose whether the video height input is visible.
-     */
-    videoHeightShow?: boolean;
-    /**
-     * Choose whether the video align radio buttons are visible.
-     */
-    videoAlignShow?: boolean;
-    /**
-     * Choose whether the video ratio options is visible.
-     */
-    videoRatioShow?: boolean;
-    /**
-     * The default width size of the video frame
-     */
-    videoWidth?: string;
-    /**
-     * The default height size of the video frame
-     */
-    videoHeight?: string;
-    /**
-     * If true, video size can only be scaled by percentage.
-     */
-    videoSizeOnlyPercentage?: boolean;
-    /**
-     * Choose whether to video rotation buttons display.
-     * When "videoSizeOnlyPercentage" is "true" or "videoHeightShow" is "false" the default value is false.
-     * If you want the button to be visible, put it a true.
-     */
-    videoRotation?: boolean;
-    /**
-     * The default aspect ratio of the video.
-     * Up to four decimal places are allowed.
-     */
-    videoRatio?: number;
-    /**
-     * Video ratio selection options.
-     */
-    videoRatioList?: { name: string; value: number }[];
-    /**
-     * The query string of a YouTube embedded URL
-     */
-    youtubeQuery?: string;
-    /**
-     * Choose whether to create a file input tag in the video upload window
-     */
-    videoFileInput?: boolean;
-    /**
-     * Choose whether to create a video url input tag in the video upload window
-     */
-    videoUrlInput?: boolean;
-    /**
-     * Http Header when uploading videos.
-     */
-    videoUploadHeader?: Record<string, string>;
-    /**
-     * The video upload to server mapping address
-     */
-    videoUploadUrl?: string;
-    /**
-     * The size of the total uploadable videos (in bytes)
-     */
-    videoUploadSizeLimit?: number;
-    /**
-     * If true, multiple videos can be selected.
-     */
-    videoMultipleFile?: boolean;
-    /**
-     * Define "Attributes" of the video tag. 
-     * @example { poster: "http://suneditor.com/docs/loading.gif", autoplay: true }
-     */
-    videoTagAttrs?: Record<string, string | boolean>;
-    /**
-     * Define "Attributes" of the iframe tag. (Youtube, Vimeo).
-     * @example { style: "border: 2px solid red;" }
-     */
-    videoIframeAttrs?: Record<string, string | boolean>;
-    /**
-     * Define the "accept" attribute of the input.
-     * "*" or ".mp4, .avi .."
-     */
-    videoAccept?: string;
-    /**
-     * Audio
-     * =====
-     */
-    /**
-     * The default width size of the audio frame
-     */
-    audioWidth?: string;
-    /**
-     * The default height size of the audio frame
-     */
-    audioHeight?: string;
-    /**
-     * Choose whether to create a file input tag in the audio upload window
-     */
-    audioFileInput?: boolean;
-    /**
-     * Choose whether to create a audio url input tag in the audio upload window
-     */
-    audioUrlInput?: boolean;
-    /**
-     * Http Header when uploading audios.
-     */
-    audioUploadHeader?: Record<string, string>;
-    /**
-     * The audio upload to server mapping address
-     */
-    audioUploadUrl?: string;
-    /**
-     * The size of the total uploadable audios (in bytes)
-     */
-    audioUploadSizeLimit?: number;
-    /**
-     * If true, videos images can be selected.
-     */
-    audioMultipleFile?: boolean;
-    /**
-     * Define "Attributes" of the audio tag.
-     * @example { controlslist: "nodownload", autoplay: true }
-     */
-    audioTagAttrs?: Record<string, string | boolean>;
-    /**
-     * Define the "accept" attribute of the input.
-     * "*" or ".mp3, .wav .."
-     */
-    audioAccept?: string;
-    /**
-     * Table
-     * =====
-     */
-    /**
-     * Define position to the table cell controller. ('cell', 'top')
-     */
-    tableCellControllerPosition?: string;
-    /**
-     * Link
-     * =====
-     */
-    /**
-     * Default checked value of the "Open in new window" checkbox.
-     */
-    linkTargetNewWindow?: boolean;
-    /**
-     * Protocol for the links (if link has been added without any protocol this one will be used).
-     */
-    linkProtocol?: string;
-    /**
-     * Defines "rel" attribute list of anchor tag.
-     */
-    linkRel?: string[];
-    /**
-     * Defines default "rel" attribute list of anchor tag.
-     */
-    linkRelDefault?: {default?: string; check_new_window?: string; check_bookmark?: string;};
-    /**
-     * If true, disables the automatic prefixing of the host URL to the value of the link. default: false {Boolean}
-     */
-    linkNoPrefix?: boolean;
-    /*
-     * HR
-     * =====
-     */
-    /**
-     * Defines the hr items.
-     * "class" or "style" must be specified.
-     * @example [{name: "solid", class: "__se__xxx", style: "border-style: outset;"}]
-     */
-    hrItems?: { name: string; class?: string; style?: string }[];
-    /**
-     * Key actions
-     * =====
-     */
-    /**
-     * If true, disables the interaction of the editor and tab key
-     */
-    tabDisable?: boolean;
-    shortcutsDisable?: string[];
-    shortcutsHint?: boolean;
-    /**
-     * Defining save button
-     * ====================
-     */
-    /**
-     * Callback functions that is called when the Save button is clicked
-     */
-    callBackSave?: (contents: string, isChanged: boolean) => void;
-    /**
-     * Templates Array
-     * ===============
-     */
-    /**
-     * Templates array
-     */
-    templates?: TemplatesItem[];
-    /**
-     * ETC
-     * ===
-     */
-    /**
-     * The placeholder text
-     */
-    placeholder?: string;
-    /**
-     * Activate the media[image, video, audio] selection status immediately after inserting the media tag. (default: true)
-     */
-    mediaAutoSelect?: boolean;
-    /**
-     * You can redefine icons.
-     */
-    icons?: Record<string, string>;
-
-    /**
-     * private options
-     */
-    _printClass?: string;
-  }
-  export type FormatTagName =
-  'p'
-  | 'div'
-  | 'blockquote'
-  | 'pre'
-  | 'h1'
-  | 'h2'
-  | 'h3'
-  | 'h4'
-  | 'h5'
-  | 'h6'
-  | { tag: string; name?: string; command: 'replace' | 'range' | 'free'; class: string };
-export type TemplatesItem = { name: string; html: string };
-export type LineHeightsItem = { text: string; value: number };
-export type ParagraphStyles = (string | { name: string; class: string; _class?: string })[];
-export type TextStyles = (string | { name: string; style: string; tag: string; _class?: string })[];
-export type ButtonListItem = any;

package/src/plugins/CommandPlugin.d.ts

@@ -1,8 +0,0 @@
-import { Plugin } from './Plugin';
-
-export interface CommandPlugin extends Plugin {
-    /**
-     * @description The behavior of the "command plugin" must be defined in the "action" method.
-     */
-    action: () => void;
-}

package/src/plugins/DialogPlugin.d.ts

@@ -1,20 +0,0 @@
-import { Plugin } from './Plugin';
-
-export interface DialogPlugin extends Plugin {
-    /**
-     * @description This method is called when the plugin button is clicked.
-     * Open the modal window here.
-     */
-    open: () => void;
-
-    /**
-     * @description Called after the submenu has been rendered
-     */
-    on?: () => void;
-
-    /**
-     * @description This method is called when the dialog window is closed.
-     * Initialize the properties.
-     */
-    init: () => void;
-}

package/src/plugins/FileBrowserPlugin.d.ts

@@ -1,30 +0,0 @@
-import { Plugin } from './Plugin';
-
-export interface FileBrowserPlugin extends Plugin {
-    /**
-     * @description Open a file browser window
-     * @param pluginName Plugin name using the file browser
-     * @param selectorHandler When the function comes as an argument value, it substitutes "context.selectorHandler".
-     * @example this.plugins.fileBrowser.open.call(this, 'imageGallery', (selectorHandler || null));
-     */
-    open(kind: string, update: boolean): void;
-
-    /**
-     * @description Define the HTML of the item to be put in "div.se-file-item-column".
-     * @param item Item of the response data's array
-     */
-    drawItems: (item: object) => string;
-
-    /**
-     * @description Close a file browser window
-     * The plugin's "init" method is called.
-     * @example this.plugins.fileBrowser.close.call(this);
-     */
-    close(): void;
-
-    /**
-     * @description This method is called when the file browser window is closed.
-     * Initialize the properties.
-     */
-    init?: () => void;
-}

package/src/plugins/Module.d.ts

@@ -1,15 +0,0 @@
-import SunEditor from '../lib/core';
-
-export interface Module {
-    /**
-     * @description Module name
-     */
-    name: string;
-    
-    /**
-     * @description Constructor, It will run automatically.
-     * @param core Core object 
-     * @example core.addModule([dialog, resizing, fileManager])
-     */
-    add?: (core: SunEditor) => void;
-}