nhn / tui.editor

🍞📝 Markdown WYSIWYG Editor. GFM Standard + Chart & UML Extensible.

http://ui.toast.com/tui-editor

MIT License

17.15k stars 1.75k forks source link

Apply @toast-ui/doc #608

Closed seonim-ryu closed 5 years ago

seonim-ryu commented 5 years ago

Version

v1.4.6

Test Environment

All

Current Behavior

Change from tui-jsdoc-template to @toast-ui/doc.

Expected Behavior

seonim-ryu commented 5 years ago

Current exposed APIs (old ver.)

APIs : https://nhn.github.io/tui.editor/api/1.4.6/#

Classes

[ ] BlockOverlay @ignore
[x] Button
[ ] CodeBlockEditor @ignore
[ ] CodeBlockGadget @ignore
[ ] CodeBlockLanguagesCombo @ignore
[x] CodeBlockManager
[ ] CodeBlockPreview @ignore
[x] CodeMirrorExt
[ ] Command @ignore
[ ] CommandManager @ignore
[ ] ComponentManager @ignore
[ ] Convertor @ignore
[x] DefaultToolbar
[x] DefaultUI
[ ] EventManager @ignore
[ ] ExtManager @ignore
[x] I18n
[ ] ImportManager @ignore
[ ] KeyMapper @ignore
[x] LayerPopup
[ ] Layout @ignore
[ ] LazyRunner @ignore
[x] MarkdownEditor
[ ] MarkdownMarkerHelper @ignore
[ ] MarkdownPreview @ignore
[ ] Markerlist @ignore
[ ] MarkerManager @ignore
[ ] MdListManager @ignore
[x] mdTextObject -> MdTextObject
[x] ModeSwitch
[ ] PopupAddHeading @ignore
[ ] PopupAddImage @ignore
[ ] PopupAddLink @ignore
[ ] PopupAddTable @ignore
[ ] PopupCodeBlockEditor @ignore
[ ] PopupCodeBlockLanguages @ignore
[ ] PopupDropdownToolbar @ignore
[x] PopupTableUtils
[ ] Preview @ignore
[ ] ScrollManager @ignore
[ ] ScrollSyncSplit @ignore
[ ] SectionManager @ignore
[x] SquireExt
[ ] Tab @ignore
[x] ToastUIEditor
[x] ToastUIEditorViewer
[x] Toolbar
[ ] ToolbarButton @ignore
[ ] ToolbarDivider @ignore
[x] ToolbarItem
[ ] ToolbarItemFactory @ignore
[ ] Tooltip @ignore
[x] UIController
[ ] ViewerMarkerHelper @ignore
[ ] WwClipboardManager @ignore
[ ] WwCodeBlockManager @ignore
[ ] WwHeadingManager @ignore
[ ] WwHrManager @ignore
[ ] WwListManager @ignore
[ ] WwMergedTableManager @ignore
[ ] WwMergedTableSelectionManager @ignore
[ ] WwPasteContentHelper @ignore
[ ] WwPManager @ignore
[ ] WwTableManager @ignore
[ ] WwTablePasteHelper @ignore
[ ] WwTableSelectionManager @ignore
[ ] WwTaskManager @ignore
[x] WwTextObject
[x] WysiwygEditor
[ ] WysiwygMarkerHelper @ignore

Global

[ ] containsNode @ignore
[ ] getAllTextNode @ignore

seonim-ryu commented 5 years ago

Editor's core

ToastUIEditor

Members

[x] Button static / @deprecated --> 일단 노출
[x] codeBlockManager static
[ ] CommandManager static / @ignore
[ ] domUtils static / @ignore --> all function are ignored
[x] i18n static
[x] isViewer static
[x] markdownit static
[x] markdownitHighlight static
[ ] WwCodeBlockManager static / @ignore
[ ] WwTableManager static / @ignore
[ ] WwTableSelectionManager static / @ignore

Methods

[x] defineExtension static
[x] factory static
[x] getInstances static
[ ] _sanitizeLinkAttribute
[x] addHook instance / options.hooks --> on 역할 동일?
[x] addWidget instance
[ ] afterAddedCommand --> 사용 용도?
[x] blur instance / options.events
[x] changeMode instance / options.initialEditType
[x] changePreviewStyle instance / options.previewStyle
[x] exec instance
[x] focus instance / options.events
[x] getCodeMirror instance
[x] getCurrentModeEditor instance
[x] getCurrentPreviewStyle instance / options.previewStyle
[x] getHtml instance
[x] getMarkdown instance
[x] getRange instance
[x] getSelectedText instance
[x] getSquire instance
[x] getTextObject instance / @returns {MdTextObject|WwTextObject}
[x] getUI instance / options.UI -> DefaultUI --> 옵션 누락? (DefaultUI 노출 안함)
[x] getValue instance / @deprecated
[x] height instance / options.height --> @TODO setHeight
[x] hide instance
[x] insertText instance
[x] isMarkdownMode instance
[x] isViewer instance
[x] isWysiwygMode instance
[x] minHeight instance / options.minHeight --> @TODO setMinHeight
[x] moveCursorToEnd instance
[x] moveCursorToStart instance
[x] off instance
[x] on instance
[x] remove instance --> @TODO destroy
[x] removeHook instance / options.hooks --> off 역할 동일?
[x] reset instance
[x] scrollTop instance
[x] setHtml instance
[x] setMarkdown instance
[x] setPlaceholder instance / options.placeholder
[x] setUI instance / options.UI -> DefaultUI --> 옵션 누락? (DefaultUI 노출 안함)
[x] setValue @deprecated --> @TODO @private
[x] show instance

ToastUIEditorViewer

Members

[x] codeBlockManager static
[ ] domUtils static / @ignore --> all function are ignored
[x] isViewer static
[x] markdownit static
[x] markdownitHighlight static

Methods

[x] defineExtension static
[x] addHook instance
[x] isMarkdownMode instance
[x] isViewer instance
[x] isWysiwygMode instance
[x] off instance
[x] on instance
[x] remove instance
[x] setMarkdown instance
[x] setValue @deprecated --> @TODO @private

Convertor

@ignore

Methods

[ ] getMarkdownitHighlightRenderer static
[ ] getMarkdownitRenderer static
[ ] setLinkAttribute instance
[ ] toHTML instance
[ ] toHTMLWithCodeHightlight instance
[ ] toMarkdown instance

seonim-ryu commented 5 years ago

Markdown

MarkdownEditor

Returned value of editor.getCurrentModeEditor()
this.cm value is set to CodeMirror
@extends {CodeMirrorExt}

Methods

[ ] factory static / @ignore
[x] getTextObject instance / @returns {MdTextObject}
[x] resetState instance
[x] setValue @override

CodeMirrorExt

Call method of CodeMirror in class

Members

[ ] this.cm instance

Methods

[x] addWidget instance
[x] blur instance
[x] focus instance
[x] getCaretPosition instance
[x] getCurrentRange instance
[x] getCursor instance
[x] getEditor instance / @returns {CodeMirror}
[x] getRange instance
[x] getValue instance
[x] getWrapperElement instance
[x] moveCursorToEnd instance
[x] moveCursorToStart instance
[x] off instance
[x] on instance
[x] remove instance
[x] replaceRelativeOffset instance
[x] replaceSelection instance
[x] reset instance
[x] scrollTop instance
[x] setHeight instance
[x] setMinHeight instance
[x] setPlaceholder instance
[x] setValue instance

mdTextObject

Change class name from mdTextObject to MdTextObject
Returned value of editor.getTextObject()
APIs are same that WwTextObject

Methods

[x] deleteContent instance
[x] expandEndOffset instance
[x] expandStartOffset instance
[x] getTextContent instance
[x] peekStartBeforeOffset instance
[x] replaceContent instance
[x] setEndBeforeRange instance
[x] setRange instance

MarkdownPreview

@extends {Preview}
@ignore

Methods

[ ] getHTML inherit
[ ] isVisible inherit
[ ] refresh inherit
[ ] render @override
[ ] setHeight inherit
[ ] setHTML inherit
[ ] setMinHeight inherit

Preview

@ignore

Methods

[ ] getHTML instance
[ ] isVisible instance
[ ] refresh instance
[ ] render instance
[ ] setHeight instance
[ ] setHTML instance
[ ] setMinHeight instance

MdListManager

@ignore

Methods

[ ] changeSyntax instance

seonim-ryu commented 5 years ago

WYSIWYG

WysiwygEditor

Returned value of editor.getCurrentModeEditor()
this.editor value is set to SquireExt

Methods

[ ] factory static / @ignore
[x] addKeyEventHandler instance
[x] addWidget instance
[x] blur instance
[x] breakToNewDefaultBlock instance
[x] changeBlockFormatTo instance
[x] findTextNodeFilter instance
[x] fixIMERange instance
[x] focus instance
[x] get$Body instance
[x] getEditor instance / @returns {SquireExt}
[x] getIMERange instance
[x] getLinkAttribute instance
[x] getRange instance
[x] getTextObject instance / @returns {WwTextObject}
[x] getValue instance
[x] hasFormatWithRx instance
[x] init instance
[x] insertText instance
[x] isInTable instance
[x] makeEmptyBlockCurrentSelection instance
[x] moveCursorToEnd instance
[x] moveCursorToStart instance
[x] postProcessForChange instance
[x] readySilentChange instance
[x] remove instance
[x] removeKeyEventHandler instance
[x] replaceContentText instance
[x] replaceRelativeOffset instance
[x] replaceSelection instance
[x] reset instance
[x] restoreSavedSelection instance
[x] saveSelection instance
[x] scrollTop instance
[x] scrollIntoCursor instance --> 추가
[x] setHeight instance
[x] setLinkAttribute instance
[x] setMinHeight instance
[x] setPlaceholder instance
[x] setRange instance
[x] setSelectionByContainerAndOffset instance
[x] setValue instance
[x] unwrapBlockTag instance

SquireExt

@extends {Squire}
@TODO seperate instance method

Methods

[ ] WysiwygEditor#scrollIntoCursor @ignore

WwTextObject

Returned value of editor.getTextObject()
APIs are same that MdTextObject

Methods

[x] deleteContent instance
[x] expandEndOffset instance
[x] expandStartOffset instance
[x] getTextContent instance
[x] peekStartBeforeOffset instance
[x] replaceContent instance
[x] setEndBeforeRange instance
[x] setRange instance

WwClipboardManager

@ignore

Methods

[ ] init instance

WwCodeBlockManager

Using in chart extension as Editor.WwCodeBlockManager
@ignore

Methods

[ ] convertNodesToText --> Using in chart extension
[ ] convertNodesToText instance
[ ] destroy instance
[ ] isInCodeBlock instance
[ ] prepareToPasteOnCodeblock instance

WwHeadingManager

@ignore

WwHrManager

@ignore

WwListManager

@ignore

Methods

[ ] adjustRange instance
[ ] createListInTable instance
[ ] isAvailableMakeListInTable instance

WwMergedTableManager

@extends {WwTableManager}
@ignore

Methods

[ ] _isDeletingBR inherit
[ ] destroy inherit
[ ] getTableIDClassName inherit
[ ] isTableOrSubTableElement inherit
[ ] pasteTableData instance
[ ] prepareToTableCellStuffing inherit
[ ] resetLastCellNode inherit
[ ] setLastCellNode inherit
[ ] tableCellAppendAidForTableElement @override
[ ] updateTableHtmlOfClipboardIfNeed @override
[ ] wrapDanglingTableCellsIntoTrIfNeed inherit
[ ] wrapTheadAndTbodyIntoTableIfNeed inherit
[ ] wrapTrsIntoTbodyIfNeed inherit

WwMergedTableSelectionManager

Create on table extension
Using in WwMergedTableSelectionManager as Editor.WwTableSelectionManager
@extends {WwTableSelectionManager}
@ignore

Methods

[ ] hasSelectedBothThAndTd instance
[ ] highlightTableCellsBy @override
[ ] onDragEnd instance
[ ] onDragStart instance
[ ] styleToSelectedCells instance

WwPManager

@ignore

WwTableManager

Using in WwMergedTableManager as Editor.WwTableManager
@ignore

Methods

[ ] _isDeletingBR
[ ] destroy instance
[ ] getTableIDClassName instance
[ ] isTableOrSubTableElement instance
[ ] pasteTableData instance
[ ] prepareToTableCellStuffing instance
[ ] resetLastCellNode instance
[ ] setLastCellNode instance
[ ] tableCellAppendAidForTableElement instance
[ ] updateTableHtmlOfClipboardIfNeed instance
[ ] wrapDanglingTableCellsIntoTrIfNeed instance
[ ] wrapTheadAndTbodyIntoTableIfNeed instance
[ ] wrapTrsIntoTbodyIfNeed instance

WwTableSelectionManager

@ignore

Methods

[ ] createRangeBySelectedCells instance
[ ] destroy instance
[ ] getSelectedCells instance
[ ] getSelectionRangeFromTable instance
[ ] highlightTableCellsBy instance
[ ] removeClassAttrbuteFromAllCellsIfNeed instance
[ ] setTableSelectionTimerIfNeed instance
[ ] styleToSelectedCells instance

WwTaskManager

@ignore

Methods

[ ] formatTask instance
[ ] isInTaskList instance
[ ] unformatTask instance

WwPasteContentHelper

Create on WwClipboardManager
@ignore

Methods

[ ] preparePaste

WwTablePasteHelper

Create on WwClipboardManager
@ignore

Methods

[ ] pasteClipboard instance

seonim-ryu commented 5 years ago

UI

Layout

@ignore

Methods

[ ] changePreviewStyle instance
[ ] getEditorEl instance
[ ] getMdEditorContainerEl instance
[ ] getPreviewEl instance
[ ] getWwEditorContainerEl instance
[ ] hide instance
[ ] init instance
[ ] remove instance
[ ] show instance
[ ] switchToMarkdown instance
[ ] switchToWYSIWYG instance

DefaultUI

Returned value of editor.getUI()

Members

[x] $el instance --> @TODO getElement()
[x] name instance --> @TODO getUIName()

Methods

[x] createPopup instance / @param {LayerPopupOption} / @returns {LayerPopup}
[x] getEditorHeight instance
[x] getEditorSectionHeight instance
[x] getModeSwitch instance / @returns {ModeSwitch}
[x] getPopupTableUtils instance / @returns {PopupTableUtils}
[x] getToolbar instance
[x] hide instance
[x] remove instance --> @TODO destroy
[x] setToolbar instance / @param {Toolbar}
[x] show instance

ToolbarButton

Create on ToolbarItemFactory
@extends {Button}
@ignore

Methods

[ ] destroy inherit
[ ] getName inherit
[ ] off inherit
[ ] on inherit
[ ] remove inherit
[ ] trigger inherit

Button

@extends {ToolbarItem}
@deprecated

Members

[ ] className static
[ ] name static

Methods

[ ] destroy inherit
[x] disable instance
[x] enable instance
[ ] getName inherit
[x] isEnabled instance
[ ] off inherit
[ ] on inherit
[ ] remove inherit
[x] setTooltip instance
[ ] trigger inherit

ToolbarDivider

Create on ToolbarItemFactory
@extends {ToolbarItem}
@ignore

ToolbarItem

@extends {UIController}

Members

[ ] name static --> @TODO move property
[ ] className static --> @TODO move property

Methods

[ ] destroy inherit
[x] getName instance
[ ] off inherit
[ ] on inherit
[ ] remove inherit
[ ] trigger inherit

ToolbarItemFactory

@ignore

DefaultToolbar

Create on DefaultUI
@extends {Toolbar}

Methods

[ ] _initEvent inherit
[ ] addButton instance / @deprecated
[ ] addDivider instance / @deprecated
[ ] addItem inherit
[x] destroy @override
[ ] disableAllButton inherit
[ ] enableAllButton inherit
[ ] getItem inherit
[ ] getItems inherit
[ ] indexOfItem inherit
[x] insertItem @override
[ ] removeAllItems inherit
[ ] removeItem inherit
[ ] setItems inherit

Toolbar

@extends {UIController}

Methods

[ ] DefaultToolbar#insertItem
[ ] _initEvent inherit
[x] addButton @deprecated
[x] addDivider @deprecated
[x] addItem instance
[x] destroy @override
[x] disableAllButton instance
[x] enableAllButton instance
[x] getItem instance
[x] getItems instance
[x] indexOfItem instance
[x] insertItem instance
[ ] off inherit
[ ] on inherit
[ ] remove inherit
[x] removeAllItems instance
[x] removeItem instance
[x] setItems instance
[ ] trigger inherit

Tab

@extends {UIController}
@ignore

Methods

[ ] activate instance
[ ] destroy inherit
[ ] off inherit
[ ] on inherit
[ ] remove inherit
[ ] trigger inherit

Tooltip

@ignore

Methods

[ ] show instance

UIController

Members

[x] $el
[x] className
[x] tagName

Methods

[x] destroy instance
[x] off instance
[x] on instance
[x] remove instance
[x] trigger instance

seonim-ryu commented 5 years ago

Popup

Create on DefaultUI

PopupAddHeading

@extends {LayerPopup}
@ignore

Methods

[ ] _initDOM inherit
[ ] _initDOMEvent @override
[ ] _initEditorEvent @override
[ ] _initInstance @override
[ ] destroy inherit
[ ] getTitleElement inherit
[ ] hide inherit
[ ] isFitToWindow inherit
[ ] isShow inherit
[ ] off inherit
[ ] on inherit
[ ] remove inherit
[ ] setContent inherit
[ ] setFitToWindow inherit
[ ] setTitle inherit
[ ] show inherit
[ ] toggleFitToWindow inherit
[ ] trigger inherit

PopupAddImage

@extends {LayerPopup}
@ignore

Methods

[ ] _initDOM @override
[ ] _initDOMEvent @override
[ ] _initEditorEvent @override
[ ] _initInstance @override
[ ] destroy inherit
[ ] getTitleElement inherit
[ ] hide inherit
[ ] isFitToWindow inherit
[ ] isShow inherit
[ ] off inherit
[ ] on inherit
[ ] remove @override
[ ] setContent inherit
[ ] setFitToWindow inherit
[ ] setTitle inherit
[ ] show inherit
[ ] toggleFitToWindow inherit
[ ] trigger inherit

PopupAddLink

@extends {LayerPopup}
@ignore

Methods

[ ] _initDOM @override
[ ] _initDOMEvent @override
[ ] _initEditorEvent @override
[ ] _initInstance @override
[ ] destroy inherit
[ ] getTitleElement inherit
[ ] hide inherit
[ ] isFitToWindow inherit
[ ] isShow inherit
[ ] off inherit
[ ] on inherit
[ ] remove inherit
[ ] setContent inherit
[ ] setFitToWindow inherit
[ ] setTitle inherit
[ ] show inherit
[ ] toggleFitToWindow inherit
[ ] trigger inherit

PopupAddTable

@extends {LayerPopup}
@ignore

Methods

[ ] _initDOM @override
[ ] _initDOMEvent @override
[ ] _initEditorEvent @override
[ ] _initInstance @override
[ ] destroy
[ ] getTitleElement
[ ] hide
[ ] isFitToWindow
[ ] isShow
[ ] off
[ ] on
[ ] remove
[ ] setContent
[ ] setFitToWindow
[ ] setTitle
[ ] show
[ ] toggleFitToWindow
[ ] trigger

PopupCodeBlockEditor

@extends {LayerPopup}
@ignore

Methods

[ ] _initDOM @override
[ ] _initDOMEvent @override
[ ] _initEditorEvent @override
[ ] _initInstance @override
[ ] destroy inherit
[ ] getTitleElement inherit
[ ] hide @override
[ ] isFitToWindow inherit
[ ] isShow inherit
[ ] off inherit
[ ] on inherit
[ ] remove inherit
[ ] setContent inherit
[ ] setFitToWindow inherit
[ ] setTitle inherit
[ ] show @override
[ ] toggleFitToWindow inherit
[ ] trigger inherit

PopupCodeBlockLanguages

@extends {LayerPopup}
@ignore

Methods

[ ] _initDOM @override
[ ] _initDOMEvent @override
[ ] _initEditorEvent @override
[ ] _initInstance @override
[ ] destroy inherit
[ ] getCurrentLanguage instance
[ ] getTitleElement inherit
[ ] hide @override
[ ] isFitToWindow inherit
[ ] isShow inherit
[ ] next instance
[ ] off inherit
[ ] on inherit
[ ] prev instance
[ ] remove inherit
[ ] setContent inherit
[ ] setCurrentLanguage
[ ] setFitToWindow inherit
[ ] setTitle inherit
[ ] show @override
[ ] toggleFitToWindow inherit
[ ] trigger inherit

PopupDropdownToolbar

@extends {LayerPopup}
@ignore

Members

[ ] OPEN_EVENT

Methods

[ ] _initDOM @override
[ ] _initEditorEvent @override
[ ] _initInstance @override
[ ] addItem instance / call method of Toolbar
[ ] getItem instance / call method of Toolbar
[ ] getItems instance / call method of Toolbar
[ ] getToolbar instance / @returns {Toolbar}
[ ] indexOfItem instance / call method of Toolbar
[ ] insertItem instance / call method of Toolbar
[ ] removeAllItems instance / call method of Toolbar
[ ] removeItem instance / call method of Toolbar
[ ] setItems instance / call method of Toolbar

PopupTableUtils

Returned value of defaultUI.getPopupTableUtils()
@extends {LayerPopup}

Methods

[ ] _initDOM inherit
[ ] _initDOMEvent @override
[ ] _initEditorEvent @override
[ ] _initInstance @override
[ ] destroy inherit
[ ] getTitleElement inherit
[ ] hide inherit
[ ] isFitToWindow inherit
[ ] isShow inherit
[ ] off inherit
[ ] on inherit
[ ] remove inherit
[ ] setContent inherit
[ ] setFitToWindow inherit
[ ] setTitle inherit
[ ] show inherit
[ ] toggleFitToWindow inherit
[ ] trigger inherit

LayerPopup

@extends {UIController}

Methods

[ ] _initDOM @private
[ ] _initDOMEvent @private
[ ] _initEditorEvent @private, @abstract
[ ] _initInstance @private
[x] destroy @override
[x] getTitleElement instance
[x] hide instance
[ ] isFitToWindow @protected
[x] isShow instance
[ ] off inherit
[ ] on inherit
[x] remove @override
[x] setContent instance
[ ] setFitToWindow @protected
[x] setTitle instance
[x] show instance
[ ] toggleFitToWindow @protected
[x] trigger @override

seonim-ryu commented 5 years ago

Manager

ComponentManager

@ignore

Methods

[ ] addManager instance
[ ] getManager instance
[ ] removeManager instance

EventManager

@ignore

Methods

[ ] addEventType instance
[ ] emit instance
[ ] emitReduce instance
[ ] listen instance
[ ] removeEventHandler instance

ExtManager

@ignore

Methods

[ ] applyExtension instance
[ ] defineExtension instance

ImportManager

@ignore

Methods

[ ] decodeURIGraceful static
[ ] encodeMarkdownCharacters static
[ ] escapeMarkdownCharacters static

seonim-ryu commented 5 years ago

Command

@ignore

Members

[ ] TYPE static

Methods

[ ] factory static --> @TODO static keyword 추가
[ ] getName instance
[ ] getType instance
[ ] isGlobalType instance
[ ] isMDType instance
[ ] isWWType instance
[ ] setKeyMap instance

CommandManager

Editor.CommandManager
@ignore

Methods

[ ] command static --> @TODO static keyword 추가
[ ] addCommand instance
[ ] exec instance

seonim-ryu commented 5 years ago

CodeBlock

CodeBlockEditor

@extends {CodeMirrorExt}
@ignore

Methods

[ ] addWidget inherit
[ ] blur inherit
[ ] clear instance
[ ] focus inherit
[ ] getCaretPosition inherit
[ ] getCurrentRange inherit
[ ] getCursor inherit
[ ] getEditor inherit
[ ] getEditorCodeText instance
[ ] getLanguage instance
[ ] getRange inherit
[ ] getValue inherit
[ ] getWrapperElement @override
[ ] load instance
[ ] moveCursorToEnd inherit
[ ] moveCursorToStart inherit
[ ] off inherit
[ ] on inherit
[ ] refresh instance
[ ] remove inherit
[ ] replaceRelativeOffset inherit
[ ] replaceSelection inherit
[ ] reset inherit
[ ] save instance
[ ] scrollTop inherit
[ ] setEditorCodeText instance
[ ] setHeight inherit
[ ] setLanguage instance
[ ] setMinHeight inherit
[ ] setPlaceholder inherit
[ ] setValue inherit

CodeBlockGadget

@extends {BlockOverlay}
@ignore

Members

[ ] active @override

Methods

[ ] getAttachedElement inherit
[ ] getVisibility inherit
[ ] onHide @override
[ ] onShow @override
[ ] setVisibility inherit
[ ] syncLayout @override

BlockOverlay

@ignore

Members

[ ] active instance

Methods

[ ] getAttachedElement instance, protected
[ ] getVisibility instance, protected
[ ] onHide instance, protected
[ ] onShow instance, protected, @abstract
[ ] setVisibility instance, protected
[ ] syncLayout instance, protected

CodeBlockLanguagesCombo

@ignore

Methods

[ ] getElement @protected
[ ] setLanguage @protected
[ ] setOnLanguageSelected @protected

CodeBlockManager

Using for custom extension
Static value of editor.codeBlockManager

Methods

[x] getHighlightJSLanguages static
[x] createCodeBlockHtml instance
[x] getReplacer instance
[x] setReplacer instance

CodeBlockPreview

@extends {Preview}
@ignore

Methods

[ ] clear instance
[ ] getHTML inherit
[ ] isVisible inherit
[ ] refresh @override
[ ] render inherit
[ ] setHeight inherit
[ ] setHTML inherit
[ ] setMinHeight inherit

seonim-ryu commented 5 years ago

ScrollSync

ScrollManager

Create on scrollSync extension
@ignore

Members

[ ] _currentTimeoutId
[ ] _savedScrollInfo

Methods

[ ] _getScrollTopForPreviewBaseCursor
[ ] saveScrollInfo instance
[ ] syncMarkdownScrollTopToPreview instance
[ ] syncPreviewScrollTopToMarkdown instance

SectionManager

Create on scrollSync extension
@ignore

Members

[ ] _currentSection
[ ] _sectionList

Methods

[ ] getSectionList instance
[ ] makeSectionList instance
[ ] sectionByLine instance
[ ] sectionMatch instance

ScrollSyncSplit

Create on PopupCodeBlockEditor
@ignore

Members

[ ] _contentElements

Methods

[ ] isScrollSynced instance
[ ] isSplitView instance
[ ] scrollTop instance
[ ] sync instance
[ ] toggleScrollSync instance
[ ] toggleSplitView instance

seonim-ryu commented 5 years ago

Marker

MarkdownMarkerHelper

Create on mark extension
@ignore

Methods

[ ] clearSelect instance
[ ] getMarkerInfoOfCurrentSelection instance
[ ] getTextContent instance
[ ] selectOffsetRange instance
[ ] updateMarkerWithExtraInfo instance

WysiwygMarkerHelper

Create on mark extension
@ignore

Methods

[ ] clearSelect instance
[ ] getMarkerInfoOfCurrentSelection instance
[ ] getTextContent instance
[ ] selectOffsetRange instance
[ ] updateMarkerWithExtraInfo instance

ViewerMarkerHelper

Create on mark extension
@ignore

Methods

[ ] clearSelect instance
[ ] getMarkerInfoOfCurrentSelection instance
[ ] getTextContent instance
[ ] selectOffsetRange instance
[ ] updateMarkerWithExtraInfo instance

Markerlist

Change class name from Markerlist to MarkerList
@ignore

Methods

[ ] addMarker instance
[ ] forEachByRangeAffected instance --> @TODO change naming
[ ] getAll instance
[ ] getMarker instance
[ ] getMarkersData
[ ] removeMarker instance
[ ] resetMarkers instance
[ ] sortBy instance
[ ] updateMarker instance

MarkerManager

@ignore

Methods

[ ] resetContent instance
[ ] updateMarkersByContent instance

seonim-ryu commented 5 years ago

etc.

LazyRunner

@ignore

I18n

Editor.i18n

Methods

[x] get instance
[x] setCode instance
[x] setLanguage instance

KeyMapper

@ignore

Methods

[ ] getSharedInstance static
[ ] keyCode instance
[ ] convert static

ModeSwitch

Returned value of defaultUI.getModeSwitch()
@extends {UIController}

Members

[ ] TYPE static / @ignore --> @TODO move out of class
[ ] _$rootElement instance / @private

Methods

[ ] destroy inherit
[x] hide instance
[x] isShown instance
[ ] off inherit
[ ] on inherit
[ ] remove inherit
[x] show instance
[ ] trigger inherit