From d52d77e176151582a4f8e6905fabb77486394156 Mon Sep 17 00:00:00 2001 From: abhijeetnarvekar Date: Tue, 20 Aug 2024 13:50:16 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20acrolinx?= =?UTF-8?q?/sidebar-sdk-js@9893e3b039a96cd2612d4ae7f5cfc94c9d7a3113=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pluginDoc/classes/AbstractRichtextEditorAdapter.html | 4 ++-- pluginDoc/classes/AcrolinxPlugin.html | 6 +++--- pluginDoc/classes/AsyncAutoBindAdapter.html | 4 ++-- pluginDoc/classes/AsyncLocalStorage.html | 4 ++-- pluginDoc/classes/AsyncMultiEditorAdapter.html | 4 ++-- pluginDoc/classes/AutoBindAdapter.html | 4 ++-- pluginDoc/classes/CKEditor5Adapter.html | 4 ++-- pluginDoc/classes/CKEditorAdapter.html | 4 ++-- pluginDoc/classes/CodeMirror6Adapter.html | 4 ++-- pluginDoc/classes/CodeMirrorAdapter.html | 4 ++-- pluginDoc/classes/ContentEditableAdapter.html | 4 ++-- pluginDoc/classes/InputAdapter.html | 4 ++-- pluginDoc/classes/MultiEditorAdapter.html | 4 ++-- pluginDoc/classes/StateBasedContentEditableAdapter.html | 4 ++-- pluginDoc/classes/TinyMCEAdapter.html | 4 ++-- pluginDoc/classes/TinyMCEWordpressAdapter.html | 4 ++-- pluginDoc/functions/autoBindFloatingSidebar.html | 2 +- pluginDoc/functions/createPluginMessageAdapter.html | 2 +- pluginDoc/functions/extractTextDomMapping.html | 2 +- pluginDoc/functions/getSelectionHtmlRanges.html | 2 +- pluginDoc/functions/initFloatingSidebar.html | 2 +- pluginDoc/functions/loadSidebarCode.html | 2 +- pluginDoc/functions/lookupMatches.html | 2 +- pluginDoc/interfaces/AdapterInterface.html | 4 ++-- pluginDoc/interfaces/AsyncAdapterInterface.html | 4 ++-- pluginDoc/interfaces/CommonAdapterInterface.html | 4 ++-- 26 files changed, 46 insertions(+), 46 deletions(-) diff --git a/pluginDoc/classes/AbstractRichtextEditorAdapter.html b/pluginDoc/classes/AbstractRichtextEditorAdapter.html index 9cee8eed..d9c449cd 100644 --- a/pluginDoc/classes/AbstractRichtextEditorAdapter.html +++ b/pluginDoc/classes/AbstractRichtextEditorAdapter.html @@ -1,4 +1,4 @@ -AbstractRichtextEditorAdapter | @acrolinx/sidebar-sdk

Class AbstractRichtextEditorAdapterAbstract

Hierarchy (view full)

Implements

Properties

config +AbstractRichtextEditorAdapter | @acrolinx/sidebar-sdk

Class AbstractRichtextEditorAdapterAbstract

Hierarchy (view full)

Implements

Properties

config currentContentChecking? lastContentChecked?

Methods

extractContentForCheck @@ -10,4 +10,4 @@ replaceRanges scrollToCurrentSelection selectRanges -

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

AbstractgetContent

AbstractgetEditorDocument

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

selectRanges

Settings

Member Visibility

On This Page

Properties
Methods
+

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

AbstractgetContent

AbstractgetEditorDocument

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

selectRanges

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/pluginDoc/classes/AcrolinxPlugin.html b/pluginDoc/classes/AcrolinxPlugin.html index dbda5bdc..df4867e9 100644 --- a/pluginDoc/classes/AcrolinxPlugin.html +++ b/pluginDoc/classes/AcrolinxPlugin.html @@ -1,11 +1,11 @@ -AcrolinxPlugin | @acrolinx/sidebar-sdk

Class AcrolinxPlugin

Constructors

constructor +AcrolinxPlugin | @acrolinx/sidebar-sdk

Class AcrolinxPlugin

Constructors

constructor

Methods

check configure dispose init registerAdapter showMessage -

Constructors

constructor

Methods

check

configure

dispose

  • dispose(callback): void

  • Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

init

registerAdapter

showMessage

  • showMessage(message): void

  • Show a message in the Sidebar. +

Constructors

constructor

Methods

check

configure

dispose

  • dispose(callback): void

  • Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

init

registerAdapter

showMessage

  • showMessage(message): void

  • Show a message in the Sidebar. Supported since Acrolinx Platform 2021.2 (Sidebar version 14.28).

    Parameters

    • message: Message

      The message to show.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/pluginDoc/classes/AsyncAutoBindAdapter.html b/pluginDoc/classes/AsyncAutoBindAdapter.html index dbb99dde..2529b742 100644 --- a/pluginDoc/classes/AsyncAutoBindAdapter.html +++ b/pluginDoc/classes/AsyncAutoBindAdapter.html @@ -1,4 +1,4 @@ -AsyncAutoBindAdapter | @acrolinx/sidebar-sdk

Class AsyncAutoBindAdapter

Implements

Constructors

constructor +AsyncAutoBindAdapter | @acrolinx/sidebar-sdk

Class AsyncAutoBindAdapter

Implements

Constructors

constructor

Properties

isAsync requiresSynchronization

Methods

extractContentForCheck @@ -7,4 +7,4 @@ registerCheckResult replaceRanges selectRanges -

Constructors

constructor

Properties

ReadonlyisAsync

isAsync: true = ...

ReadonlyrequiresSynchronization

requiresSynchronization: true = ...

Methods

extractContentForCheck

getFormat

registerCheckCall

registerCheckResult

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyisAsync

isAsync: true = ...

ReadonlyrequiresSynchronization

requiresSynchronization: true = ...

Methods

extractContentForCheck

getFormat

registerCheckCall

registerCheckResult

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/pluginDoc/classes/AsyncLocalStorage.html b/pluginDoc/classes/AsyncLocalStorage.html index 9ac9aea8..632e7ced 100644 --- a/pluginDoc/classes/AsyncLocalStorage.html +++ b/pluginDoc/classes/AsyncLocalStorage.html @@ -1,4 +1,4 @@ -AsyncLocalStorage | @acrolinx/sidebar-sdk

Class AsyncLocalStorage

Implements

  • AsyncStorage

Constructors

constructor +AsyncLocalStorage | @acrolinx/sidebar-sdk

Class AsyncLocalStorage

Implements

  • AsyncStorage

Constructors

constructor

Methods

get set -

Constructors

constructor

Methods

get

set

  • set<T>(key, value): Promise<undefined>

  • Type Parameters

    • T

    Parameters

    • key: string
    • value: T

    Returns Promise<undefined>

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

get

set

  • set<T>(key, value): Promise<undefined>

  • Type Parameters

    • T

    Parameters

    • key: string
    • value: T

    Returns Promise<undefined>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/pluginDoc/classes/AsyncMultiEditorAdapter.html b/pluginDoc/classes/AsyncMultiEditorAdapter.html index b4d95ea5..df7fb3b2 100644 --- a/pluginDoc/classes/AsyncMultiEditorAdapter.html +++ b/pluginDoc/classes/AsyncMultiEditorAdapter.html @@ -1,4 +1,4 @@ -AsyncMultiEditorAdapter | @acrolinx/sidebar-sdk

Class AsyncMultiEditorAdapter

Hierarchy (view full)

Implements

Constructors

constructor +AsyncMultiEditorAdapter | @acrolinx/sidebar-sdk

Class AsyncMultiEditorAdapter

Hierarchy (view full)

Implements

Constructors

constructor

Properties

isAsync requiresSynchronization

Methods

addSingleAdapter @@ -11,4 +11,4 @@ removeAllAdapters replaceRanges selectRanges -

Constructors

constructor

Properties

ReadonlyisAsync

isAsync: true = ...

ReadonlyrequiresSynchronization

requiresSynchronization: true = ...

Methods

addSingleAdapter

extractContentForCheck

getAdapterForMatch

getFormat

registerCheckCall

registerCheckResult

remapMatches

removeAllAdapters

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyisAsync

isAsync: true = ...

ReadonlyrequiresSynchronization

requiresSynchronization: true = ...

Methods

addSingleAdapter

extractContentForCheck

getAdapterForMatch

getFormat

registerCheckCall

registerCheckResult

remapMatches

removeAllAdapters

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/pluginDoc/classes/AutoBindAdapter.html b/pluginDoc/classes/AutoBindAdapter.html index 21458891..f9731b85 100644 --- a/pluginDoc/classes/AutoBindAdapter.html +++ b/pluginDoc/classes/AutoBindAdapter.html @@ -1,8 +1,8 @@ -AutoBindAdapter | @acrolinx/sidebar-sdk

Class AutoBindAdapter

Implements

Constructors

constructor +AutoBindAdapter | @acrolinx/sidebar-sdk

Class AutoBindAdapter

Implements

Constructors

constructor

Methods

extractContentForCheck getFormat registerCheckCall registerCheckResult replaceRanges selectRanges -

Constructors

constructor

Methods

extractContentForCheck

getFormat

registerCheckCall

registerCheckResult

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

extractContentForCheck

getFormat

registerCheckCall

registerCheckResult

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/pluginDoc/classes/CKEditor5Adapter.html b/pluginDoc/classes/CKEditor5Adapter.html index 53576c39..5274e552 100644 --- a/pluginDoc/classes/CKEditor5Adapter.html +++ b/pluginDoc/classes/CKEditor5Adapter.html @@ -1,4 +1,4 @@ -CKEditor5Adapter | @acrolinx/sidebar-sdk

Class CKEditor5Adapter

Hierarchy (view full)

Constructors

constructor +CKEditor5Adapter | @acrolinx/sidebar-sdk

Class CKEditor5Adapter

Hierarchy (view full)

Constructors

constructor

Properties

config currentContentChecking? editorId @@ -15,4 +15,4 @@ replaceRanges scrollToCurrentSelection selectRanges -

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

editorId

editorId: string

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getEditor

getEditorDocument

getEditorElement

isInSourceEditingMode

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

editorId

editorId: string

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getEditor

getEditorDocument

getEditorElement

isInSourceEditingMode

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/pluginDoc/classes/CKEditorAdapter.html b/pluginDoc/classes/CKEditorAdapter.html index 54ce2e95..ea57a1cb 100644 --- a/pluginDoc/classes/CKEditorAdapter.html +++ b/pluginDoc/classes/CKEditorAdapter.html @@ -1,4 +1,4 @@ -CKEditorAdapter | @acrolinx/sidebar-sdk

Class CKEditorAdapter

Hierarchy (view full)

Constructors

constructor +CKEditorAdapter | @acrolinx/sidebar-sdk

Class CKEditorAdapter

Hierarchy (view full)

Constructors

constructor

Properties

config currentContentChecking? editorId @@ -14,4 +14,4 @@ replaceRanges scrollToCurrentSelection selectRanges -

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

editorId

editorId: string

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getEditor

getEditorDocument

isInWysiwygMode

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

editorId

editorId: string

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getEditor

getEditorDocument

isInWysiwygMode

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/pluginDoc/classes/CodeMirror6Adapter.html b/pluginDoc/classes/CodeMirror6Adapter.html index 5dc7ed3f..7def184c 100644 --- a/pluginDoc/classes/CodeMirror6Adapter.html +++ b/pluginDoc/classes/CodeMirror6Adapter.html @@ -1,4 +1,4 @@ -CodeMirror6Adapter | @acrolinx/sidebar-sdk

Class CodeMirror6Adapter

Implements

Constructors

constructor +CodeMirror6Adapter | @acrolinx/sidebar-sdk

Class CodeMirror6Adapter

Implements

Constructors

constructor

Methods

configure extractContentForCheck getContent @@ -7,4 +7,4 @@ registerCheckResult replaceRanges selectRanges -

Constructors

constructor

Methods

configure

extractContentForCheck

getContent

getFormat

registerCheckCall

registerCheckResult

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

configure

extractContentForCheck

getContent

getFormat

registerCheckCall

registerCheckResult

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/pluginDoc/classes/CodeMirrorAdapter.html b/pluginDoc/classes/CodeMirrorAdapter.html index f6986363..a5dc7264 100644 --- a/pluginDoc/classes/CodeMirrorAdapter.html +++ b/pluginDoc/classes/CodeMirrorAdapter.html @@ -1,4 +1,4 @@ -CodeMirrorAdapter | @acrolinx/sidebar-sdk

Class CodeMirrorAdapter

Implements

Constructors

constructor +CodeMirrorAdapter | @acrolinx/sidebar-sdk

Class CodeMirrorAdapter

Implements

Constructors

constructor

Methods

configure extractContentForCheck getContent @@ -7,4 +7,4 @@ registerCheckResult replaceRanges selectRanges -

Constructors

constructor

Methods

configure

extractContentForCheck

getContent

getFormat

registerCheckCall

registerCheckResult

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

configure

extractContentForCheck

getContent

getFormat

registerCheckCall

registerCheckResult

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/pluginDoc/classes/ContentEditableAdapter.html b/pluginDoc/classes/ContentEditableAdapter.html index 33bc1b35..665d428f 100644 --- a/pluginDoc/classes/ContentEditableAdapter.html +++ b/pluginDoc/classes/ContentEditableAdapter.html @@ -1,4 +1,4 @@ -ContentEditableAdapter | @acrolinx/sidebar-sdk

Class ContentEditableAdapter

Hierarchy (view full)

Constructors

constructor +ContentEditableAdapter | @acrolinx/sidebar-sdk

Class ContentEditableAdapter

Hierarchy (view full)

Constructors

constructor

Properties

config currentContentChecking? element @@ -13,4 +13,4 @@ replaceRanges scrollToCurrentSelection selectRanges -

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

element

element: HTMLElement

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getEditorDocument

getEditorElement

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

element

element: HTMLElement

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getEditorDocument

getEditorElement

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/pluginDoc/classes/InputAdapter.html b/pluginDoc/classes/InputAdapter.html index 1cf30689..a81f2435 100644 --- a/pluginDoc/classes/InputAdapter.html +++ b/pluginDoc/classes/InputAdapter.html @@ -1,4 +1,4 @@ -InputAdapter | @acrolinx/sidebar-sdk

Class InputAdapter

Implements

Constructors

constructor +InputAdapter | @acrolinx/sidebar-sdk

Class InputAdapter

Implements

Constructors

constructor

Properties

config element

Methods

extractContentForCheck @@ -13,4 +13,4 @@ scrollAndSelect selectMatches selectRanges -

Constructors

constructor

Properties

config

config: InputAdapterConf

Readonlyelement

element: ValidInputElement

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getCurrentText

getFormat

registerCheckCall

registerCheckResult

replaceAlignedMatches

  • replaceAlignedMatches(matches): void

  • Parameters

    • matches: AlignedMatch<MatchWithReplacement>[]

    Returns void

replaceRanges

scrollAndSelect

selectMatches

  • selectMatches<T>(_checkId, matches): AlignedMatch<T>[]

  • Type Parameters

    • T extends Match

    Parameters

    • _checkId: string
    • matches: T[]

    Returns AlignedMatch<T>[]

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

config

config: InputAdapterConf

Readonlyelement

element: ValidInputElement

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getCurrentText

getFormat

registerCheckCall

registerCheckResult

replaceAlignedMatches

  • replaceAlignedMatches(matches): void

  • Parameters

    • matches: AlignedMatch<MatchWithReplacement>[]

    Returns void

replaceRanges

scrollAndSelect

selectMatches

  • selectMatches<T>(_checkId, matches): AlignedMatch<T>[]

  • Type Parameters

    • T extends Match

    Parameters

    • _checkId: string
    • matches: T[]

    Returns AlignedMatch<T>[]

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/pluginDoc/classes/MultiEditorAdapter.html b/pluginDoc/classes/MultiEditorAdapter.html index 7b6c8feb..3c59a04b 100644 --- a/pluginDoc/classes/MultiEditorAdapter.html +++ b/pluginDoc/classes/MultiEditorAdapter.html @@ -1,4 +1,4 @@ -MultiEditorAdapter | @acrolinx/sidebar-sdk

Class MultiEditorAdapter

Hierarchy (view full)

Implements

Constructors

constructor +MultiEditorAdapter | @acrolinx/sidebar-sdk

Class MultiEditorAdapter

Hierarchy (view full)

Implements

Constructors

constructor

Methods

addSingleAdapter extractContentForCheck getAdapterForMatch @@ -9,4 +9,4 @@ removeAllAdapters replaceRanges selectRanges -

Constructors

constructor

Methods

addSingleAdapter

extractContentForCheck

getAdapterForMatch

getFormat

registerCheckCall

registerCheckResult

remapMatches

  • remapMatches<T>(matches): {
        [id: string]: RemappedMatches<T>;
    }

  • Type Parameters

    • T extends Match

    Parameters

    • matches: T[]

    Returns {
        [id: string]: RemappedMatches<T>;
    }

    • [id: string]: RemappedMatches<T>

removeAllAdapters

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addSingleAdapter

extractContentForCheck

getAdapterForMatch

getFormat

registerCheckCall

registerCheckResult

remapMatches

  • remapMatches<T>(matches): {
        [id: string]: RemappedMatches<T>;
    }

  • Type Parameters

    • T extends Match

    Parameters

    • matches: T[]

    Returns {
        [id: string]: RemappedMatches<T>;
    }

    • [id: string]: RemappedMatches<T>

removeAllAdapters

replaceRanges

selectRanges

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/pluginDoc/classes/StateBasedContentEditableAdapter.html b/pluginDoc/classes/StateBasedContentEditableAdapter.html index 0faedd9a..05e364dc 100644 --- a/pluginDoc/classes/StateBasedContentEditableAdapter.html +++ b/pluginDoc/classes/StateBasedContentEditableAdapter.html @@ -1,4 +1,4 @@ -StateBasedContentEditableAdapter | @acrolinx/sidebar-sdk

Class StateBasedContentEditableAdapter

Hierarchy (view full)

Implements

Constructors

constructor +StateBasedContentEditableAdapter | @acrolinx/sidebar-sdk

Class StateBasedContentEditableAdapter

Hierarchy (view full)

Implements

Constructors

constructor

Properties

config currentContentChecking? element @@ -17,4 +17,4 @@ scrollToCurrentSelection selectRanges selectText -

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

element

element: HTMLElement

ReadonlyisAsync

isAsync: true = ...

OptionallastContentChecked

lastContentChecked?: string

ReadonlyrequiresSynchronization

requiresSynchronization: true = ...

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getEditorDocument

getEditorElement

registerCheckCall

registerCheckResult

replaceRanges

scrollIntoView

scrollToCurrentSelection

selectRanges

selectText

  • selectText(begin, length, textMapping): Promise<void>

  • Parameters

    • begin: number
    • length: number
    • textMapping: TextDomMapping

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

element

element: HTMLElement

ReadonlyisAsync

isAsync: true = ...

OptionallastContentChecked

lastContentChecked?: string

ReadonlyrequiresSynchronization

requiresSynchronization: true = ...

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getEditorDocument

getEditorElement

registerCheckCall

registerCheckResult

replaceRanges

scrollIntoView

scrollToCurrentSelection

selectRanges

selectText

  • selectText(begin, length, textMapping): Promise<void>

  • Parameters

    • begin: number
    • length: number
    • textMapping: TextDomMapping

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/pluginDoc/classes/TinyMCEAdapter.html b/pluginDoc/classes/TinyMCEAdapter.html index 7ad4a913..721f56db 100644 --- a/pluginDoc/classes/TinyMCEAdapter.html +++ b/pluginDoc/classes/TinyMCEAdapter.html @@ -1,4 +1,4 @@ -TinyMCEAdapter | @acrolinx/sidebar-sdk

Class TinyMCEAdapter

Hierarchy (view full)

Constructors

constructor +TinyMCEAdapter | @acrolinx/sidebar-sdk

Class TinyMCEAdapter

Hierarchy (view full)

Constructors

constructor

Properties

config currentContentChecking? editorId @@ -14,4 +14,4 @@ replaceRanges scrollToCurrentSelection selectRanges -

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

editorId

editorId: string

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getContentForCheckSelection

getEditor

getEditorDocument

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

editorId

editorId: string

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getContentForCheckSelection

getEditor

getEditorDocument

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/pluginDoc/classes/TinyMCEWordpressAdapter.html b/pluginDoc/classes/TinyMCEWordpressAdapter.html index a2f01159..d6d1f1cf 100644 --- a/pluginDoc/classes/TinyMCEWordpressAdapter.html +++ b/pluginDoc/classes/TinyMCEWordpressAdapter.html @@ -1,4 +1,4 @@ -TinyMCEWordpressAdapter | @acrolinx/sidebar-sdk

Class TinyMCEWordpressAdapter

Hierarchy (view full)

Constructors

constructor +TinyMCEWordpressAdapter | @acrolinx/sidebar-sdk

Class TinyMCEWordpressAdapter

Hierarchy (view full)

Constructors

constructor

Properties

config currentContentChecking? editorId @@ -15,4 +15,4 @@ scrollToCurrentSelection scrollToCurrentSelectionWithGlobalScrollbar selectRanges -

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

editorId

editorId: string

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getContentForCheckSelection

getEditor

getEditorDocument

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

scrollToCurrentSelectionWithGlobalScrollbar

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

config

config: AdapterConf

OptionalcurrentContentChecking

currentContentChecking?: string

editorId

editorId: string

OptionallastContentChecked

lastContentChecked?: string

Methods

extractContentForCheck

getAutobindWrapperAttributes

getContent

getContentForCheckSelection

getEditor

getEditorDocument

registerCheckCall

registerCheckResult

replaceRanges

scrollToCurrentSelection

scrollToCurrentSelectionWithGlobalScrollbar

selectRanges

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/pluginDoc/functions/autoBindFloatingSidebar.html b/pluginDoc/functions/autoBindFloatingSidebar.html index c7d1b3a8..573aa9b2 100644 --- a/pluginDoc/functions/autoBindFloatingSidebar.html +++ b/pluginDoc/functions/autoBindFloatingSidebar.html @@ -1 +1 @@ -autoBindFloatingSidebar | @acrolinx/sidebar-sdk

Function autoBindFloatingSidebar

  • autoBindFloatingSidebar(basicConf): FloatingSidebar

  • Parameters

    • basicConf: AutoBindFloatingSidebarConfig

    Returns FloatingSidebar

Settings

Member Visibility
+autoBindFloatingSidebar | @acrolinx/sidebar-sdk

Function autoBindFloatingSidebar

  • autoBindFloatingSidebar(basicConf): FloatingSidebar

  • Parameters

    • basicConf: AutoBindFloatingSidebarConfig

    Returns FloatingSidebar

Settings

Member Visibility
diff --git a/pluginDoc/functions/createPluginMessageAdapter.html b/pluginDoc/functions/createPluginMessageAdapter.html index aae593b0..ebb1e035 100644 --- a/pluginDoc/functions/createPluginMessageAdapter.html +++ b/pluginDoc/functions/createPluginMessageAdapter.html @@ -1,2 +1,2 @@ createPluginMessageAdapter | @acrolinx/sidebar-sdk

Function createPluginMessageAdapter

  • createPluginMessageAdapter(win?): AcrolinxPlugin

  • Used inside of a sidebar iframe on a different domain.

    -

    Parameters

    • win: Window & typeof globalThis = window

    Returns AcrolinxPlugin

Settings

Member Visibility
+

Parameters

Returns AcrolinxPlugin

Settings

Member Visibility
diff --git a/pluginDoc/functions/extractTextDomMapping.html b/pluginDoc/functions/extractTextDomMapping.html index 2ba849ce..24fd56be 100644 --- a/pluginDoc/functions/extractTextDomMapping.html +++ b/pluginDoc/functions/extractTextDomMapping.html @@ -1 +1 @@ -extractTextDomMapping | @acrolinx/sidebar-sdk

Function extractTextDomMapping

Settings

Member Visibility
+extractTextDomMapping | @acrolinx/sidebar-sdk

Function extractTextDomMapping

Settings

Member Visibility
diff --git a/pluginDoc/functions/getSelectionHtmlRanges.html b/pluginDoc/functions/getSelectionHtmlRanges.html index b9bb195d..2ef4fbc8 100644 --- a/pluginDoc/functions/getSelectionHtmlRanges.html +++ b/pluginDoc/functions/getSelectionHtmlRanges.html @@ -1 +1 @@ -getSelectionHtmlRanges | @acrolinx/sidebar-sdk

Function getSelectionHtmlRanges

  • getSelectionHtmlRanges(editorElement, getElementHtml?): [number, number][]

  • Parameters

    • editorElement: HTMLElement
    • getElementHtml: ElementHtmlGetter = getInnerHtml

    Returns [number, number][]

Settings

Member Visibility
+getSelectionHtmlRanges | @acrolinx/sidebar-sdk

Function getSelectionHtmlRanges

  • getSelectionHtmlRanges(editorElement, getElementHtml?): [number, number][]

  • Parameters

    • editorElement: HTMLElement
    • getElementHtml: ElementHtmlGetter = getInnerHtml

    Returns [number, number][]

Settings

Member Visibility
diff --git a/pluginDoc/functions/initFloatingSidebar.html b/pluginDoc/functions/initFloatingSidebar.html index 2e159dbf..e0ec52dc 100644 --- a/pluginDoc/functions/initFloatingSidebar.html +++ b/pluginDoc/functions/initFloatingSidebar.html @@ -1 +1 @@ -initFloatingSidebar | @acrolinx/sidebar-sdk

Function initFloatingSidebar

Settings

Member Visibility
+initFloatingSidebar | @acrolinx/sidebar-sdk

Function initFloatingSidebar

Settings

Member Visibility
diff --git a/pluginDoc/functions/loadSidebarCode.html b/pluginDoc/functions/loadSidebarCode.html index ac04deb5..4dd677c5 100644 --- a/pluginDoc/functions/loadSidebarCode.html +++ b/pluginDoc/functions/loadSidebarCode.html @@ -1,2 +1,2 @@ loadSidebarCode | @acrolinx/sidebar-sdk

Function loadSidebarCode

  • loadSidebarCode(sidebarBaseUrl): void

  • Loads the Styles and Scripts of the sidebar into the current window.

    -

    Parameters

    • sidebarBaseUrl: string

    Returns void

Settings

Member Visibility
+

Parameters

Returns void

Settings

Member Visibility
diff --git a/pluginDoc/functions/lookupMatches.html b/pluginDoc/functions/lookupMatches.html index c3576f72..9e143e59 100644 --- a/pluginDoc/functions/lookupMatches.html +++ b/pluginDoc/functions/lookupMatches.html @@ -3,4 +3,4 @@
  • matches: T[]
  • inputFormat: InputFormat = 'HTML'

    If checkedDocument is the HTML of the document (at check time) and currentDocument is the extracted text of the current document then you should set inputFormat to 'HTML'.

    -

    • Returns AlignedMatch<T>[]

    Settings

    Member Visibility
    +

    Returns AlignedMatch<T>[]

    Settings

    Member Visibility
    diff --git a/pluginDoc/interfaces/AdapterInterface.html b/pluginDoc/interfaces/AdapterInterface.html index 7e8b49e4..68765647 100644 --- a/pluginDoc/interfaces/AdapterInterface.html +++ b/pluginDoc/interfaces/AdapterInterface.html @@ -1,4 +1,4 @@ -AdapterInterface | @acrolinx/sidebar-sdk

    Interface AdapterInterface

    interface AdapterInterface {
        extractContentForCheck(opts: ExtractContentForCheckOpts): ContentExtractionResult | Promise<ContentExtractionResult>;
        getAutobindWrapperAttributes?(): AutobindWrapperAttributes;
        getContent?(opts: ExtractContentForCheckOpts): string;
        getFormat?(): string;
        onInitFinished?(result: InitResult): void;
        registerCheckCall(checkInfo: Check): void;
        registerCheckResult(checkResult: SuccessfulCheckResult): void;
        replaceRanges(checkId: string, matchesWithReplacement: MatchWithReplacement[]): void;
        selectRanges(checkId: string, matches: Match[]): void;
    }

    Hierarchy (view full)

    Implemented by

    Methods

    extractContentForCheck +AdapterInterface | @acrolinx/sidebar-sdk

    Interface AdapterInterface

    interface AdapterInterface {
        extractContentForCheck(opts: ExtractContentForCheckOpts): ContentExtractionResult | Promise<ContentExtractionResult>;
        getAutobindWrapperAttributes?(): AutobindWrapperAttributes;
        getContent?(opts: ExtractContentForCheckOpts): string;
        getFormat?(): string;
        onInitFinished?(result: InitResult): void;
        registerCheckCall(checkInfo: Check): void;
        registerCheckResult(checkResult: SuccessfulCheckResult): void;
        replaceRanges(checkId: string, matchesWithReplacement: MatchWithReplacement[]): void;
        selectRanges(checkId: string, matches: Match[]): void;
    }

    Hierarchy (view full)

    Implemented by

    Methods

    extractContentForCheck getAutobindWrapperAttributes? getContent? getFormat? @@ -7,4 +7,4 @@ registerCheckResult replaceRanges selectRanges -

    Methods

    extractContentForCheck

    OptionalgetAutobindWrapperAttributes

    OptionalgetContent

    OptionalgetFormat

    OptionalonInitFinished

    registerCheckCall

    registerCheckResult

    replaceRanges

    • replaceRanges(checkId, matchesWithReplacement): void

    • Parameters

      • checkId: string
      • matchesWithReplacement: MatchWithReplacement[]

      Returns void

    selectRanges

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Methods

    extractContentForCheck

    OptionalgetAutobindWrapperAttributes

    OptionalgetContent

    OptionalgetFormat

    OptionalonInitFinished

    registerCheckCall

    registerCheckResult

    replaceRanges

    • replaceRanges(checkId, matchesWithReplacement): void

    • Parameters

      • checkId: string
      • matchesWithReplacement: MatchWithReplacement[]

      Returns void

    selectRanges

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/pluginDoc/interfaces/AsyncAdapterInterface.html b/pluginDoc/interfaces/AsyncAdapterInterface.html index 706fa560..e9a34e99 100644 --- a/pluginDoc/interfaces/AsyncAdapterInterface.html +++ b/pluginDoc/interfaces/AsyncAdapterInterface.html @@ -1,4 +1,4 @@ -AsyncAdapterInterface | @acrolinx/sidebar-sdk

    Interface AsyncAdapterInterface

    interface AsyncAdapterInterface {
        isAsync: true;
        requiresSynchronization: boolean;
        extractContentForCheck(opts: ExtractContentForCheckOpts): ContentExtractionResult | Promise<ContentExtractionResult>;
        getAutobindWrapperAttributes?(): AutobindWrapperAttributes;
        getContent?(opts: ExtractContentForCheckOpts): string;
        getFormat?(): string;
        onInitFinished?(result: InitResult): void;
        registerCheckCall(checkInfo: Check): void;
        registerCheckResult(checkResult: SuccessfulCheckResult): void;
        replaceRanges(checkId: string, matchesWithReplacement: MatchWithReplacement[]): Promise<void>;
        selectRanges(checkId: string, matches: Match[]): Promise<void>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    isAsync +AsyncAdapterInterface | @acrolinx/sidebar-sdk

    Interface AsyncAdapterInterface

    interface AsyncAdapterInterface {
        isAsync: true;
        requiresSynchronization: boolean;
        extractContentForCheck(opts: ExtractContentForCheckOpts): ContentExtractionResult | Promise<ContentExtractionResult>;
        getAutobindWrapperAttributes?(): AutobindWrapperAttributes;
        getContent?(opts: ExtractContentForCheckOpts): string;
        getFormat?(): string;
        onInitFinished?(result: InitResult): void;
        registerCheckCall(checkInfo: Check): void;
        registerCheckResult(checkResult: SuccessfulCheckResult): void;
        replaceRanges(checkId: string, matchesWithReplacement: MatchWithReplacement[]): Promise<void>;
        selectRanges(checkId: string, matches: Match[]): Promise<void>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    isAsync requiresSynchronization

    Methods

    extractContentForCheck getAutobindWrapperAttributes? @@ -9,4 +9,4 @@ registerCheckResult replaceRanges selectRanges -

    Properties

    ReadonlyisAsync

    isAsync: true

    ReadonlyrequiresSynchronization

    requiresSynchronization: boolean

    Methods

    extractContentForCheck

    OptionalgetAutobindWrapperAttributes

    OptionalgetContent

    OptionalgetFormat

    OptionalonInitFinished

    registerCheckCall

    registerCheckResult

    replaceRanges

    • replaceRanges(checkId, matchesWithReplacement): Promise<void>

    • Parameters

      • checkId: string
      • matchesWithReplacement: MatchWithReplacement[]

      Returns Promise<void>

    selectRanges

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Properties

    ReadonlyisAsync

    isAsync: true

    ReadonlyrequiresSynchronization

    requiresSynchronization: boolean

    Methods

    extractContentForCheck

    OptionalgetAutobindWrapperAttributes

    OptionalgetContent

    OptionalgetFormat

    OptionalonInitFinished

    registerCheckCall

    registerCheckResult

    replaceRanges

    • replaceRanges(checkId, matchesWithReplacement): Promise<void>

    • Parameters

      • checkId: string
      • matchesWithReplacement: MatchWithReplacement[]

      Returns Promise<void>

    selectRanges

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/pluginDoc/interfaces/CommonAdapterInterface.html b/pluginDoc/interfaces/CommonAdapterInterface.html index 8e262ff0..6b8f58d6 100644 --- a/pluginDoc/interfaces/CommonAdapterInterface.html +++ b/pluginDoc/interfaces/CommonAdapterInterface.html @@ -1,8 +1,8 @@ -CommonAdapterInterface | @acrolinx/sidebar-sdk

    Interface CommonAdapterInterface

    interface CommonAdapterInterface {
        extractContentForCheck(opts: ExtractContentForCheckOpts): ContentExtractionResult | Promise<ContentExtractionResult>;
        getAutobindWrapperAttributes?(): AutobindWrapperAttributes;
        getContent?(opts: ExtractContentForCheckOpts): string;
        getFormat?(): string;
        onInitFinished?(result: InitResult): void;
        registerCheckCall(checkInfo: Check): void;
        registerCheckResult(checkResult: SuccessfulCheckResult): void;
    }

    Hierarchy (view full)

    Methods

    extractContentForCheck +CommonAdapterInterface | @acrolinx/sidebar-sdk

    Interface CommonAdapterInterface

    interface CommonAdapterInterface {
        extractContentForCheck(opts: ExtractContentForCheckOpts): ContentExtractionResult | Promise<ContentExtractionResult>;
        getAutobindWrapperAttributes?(): AutobindWrapperAttributes;
        getContent?(opts: ExtractContentForCheckOpts): string;
        getFormat?(): string;
        onInitFinished?(result: InitResult): void;
        registerCheckCall(checkInfo: Check): void;
        registerCheckResult(checkResult: SuccessfulCheckResult): void;
    }

    Hierarchy (view full)

    Methods

    extractContentForCheck getAutobindWrapperAttributes? getContent? getFormat? onInitFinished? registerCheckCall registerCheckResult -

    Methods

    extractContentForCheck

    • extractContentForCheck(opts): ContentExtractionResult | Promise<ContentExtractionResult>

    • Parameters

      • opts: ExtractContentForCheckOpts

      Returns ContentExtractionResult | Promise<ContentExtractionResult>

    OptionalgetAutobindWrapperAttributes

    OptionalgetContent

    OptionalgetFormat

    OptionalonInitFinished

    registerCheckCall

    registerCheckResult

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Methods

    extractContentForCheck

    • extractContentForCheck(opts): ContentExtractionResult | Promise<ContentExtractionResult>

    • Parameters

      • opts: ExtractContentForCheckOpts

      Returns ContentExtractionResult | Promise<ContentExtractionResult>

    OptionalgetAutobindWrapperAttributes

    OptionalgetContent

    OptionalgetFormat

    OptionalonInitFinished

    registerCheckCall

    registerCheckResult

    Settings

    Member Visibility

    On This Page

    Methods