Skip to content

Latest commit

 

History

History
167 lines (101 loc) · 5.11 KB

globals.md

File metadata and controls

167 lines (101 loc) · 5.11 KB
Raw

@guardian/prosemirror-typerighter › Globals

@guardian/prosemirror-typerighter

Index

Classes

Functions

Functions

Const convertTyperighterResponse

▸ convertTyperighterResponse(requestId: string, response: ITypeRighterResponse): IMatcherResponse

Defined in services/adapters/TyperighterAdapter.ts:18

Convert an incoming response from a Typerighter service into the IMatcherResponse that the plugin expects.

Parameters:

Name Type
requestId string
response ITypeRighterResponse

Returns: IMatcherResponse

Const createBoundCommands

▸ createBoundCommands‹TMatch›(view: EditorView, getState: GetState‹TMatch›): object

Defined in commands.ts:301

Create a palette of prosemirror-typerighter commands bound to the given EditorView.

Type parameters:

▪ TMatch: IMatch

Parameters:

Name Type
view EditorView
getState GetState‹TMatch›

Returns: object

  • applyMatcherResponse: (Anonymous function) = bindCommand(applyMatcherResponseCommand)

  • applyRequestComplete: (Anonymous function) = bindCommand(applyRequestCompleteCommand)

  • applyRequestError: (Anonymous function) = bindCommand(applyRequestErrorCommand)

  • indicateHover: (Anonymous function) = bindCommand(indicateHoverCommand)

  • requestMatchesForDirtyRanges: (Anonymous function) = bindCommand( requestMatchesForDirtyRangesCommand )

  • requestMatchesForDocument: (Anonymous function) = bindCommand(requestMatchesForDocumentCommand)

  • setDebugState: (Anonymous function) = bindCommand(setDebugStateCommand)

  • setRequestOnDocModified: (Anonymous function) = bindCommand(setRequestOnDocModifiedState)

  • stopHover: (Anonymous function) = bindCommand(stopHoverCommand)

  • applyAutoFixableSuggestions(): boolean

  • applySuggestions(suggestionOpts: ApplySuggestionOptions): boolean

  • selectMatch(blockId: string): boolean

Const createTyperighterPlugin

▸ createTyperighterPlugin‹TMatch›(options: IPluginOptions‹TMatch›): object

Defined in createTyperighterPlugin.ts:47

Creates the prosemirror-typerighter plugin. Responsible for issuing requests when the document is changed via the supplied servier, decorating the document with matches when they are are returned, and applying suggestions to the document.

Type parameters:

▪ TMatch: IMatch

Parameters:

Name Type Default Description
options IPluginOptions‹TMatch› {} The plugin options object.

Returns: object

  • getState(): function

    • (state: EditorState): TPluginState

  • plugin: Plugin‹any, any›

  • store: Store‹IMatch‹ITextSuggestion | IWikiSuggestion›, IStoreEvents‹IMatch‹ITextSuggestion | IWikiSuggestion›››

Const createView

▸ createView(view: EditorView, store: Store‹IMatch›, matcherService: MatcherService‹IMatch›, commands: Commands, sidebarNode: Element, controlsNode: Element, contactHref?: undefined | string, feedbackHref?: undefined | string): void

Defined in createView.tsx:18

Instantiate a UI for the given EditorView, commands, and configuration, appending it to the given HTML elements. This includes:

  • The overlay responsible for displaying tooltips
  • The plugin configuration pane
  • The plugin results pane

Parameters:

Name Type
view EditorView
store Store‹IMatch›
matcherService MatcherService‹IMatch›
commands Commands
sidebarNode Element
controlsNode Element
contactHref? undefined | string
feedbackHref? undefined | string

Returns: void

Const getBlocksFromDocument

▸ getBlocksFromDocument(doc: Node, time: number): IBlock[]

Defined in utils/prosemirror.ts:41

Create IBlock objects from the block leaf nodes of a given document.

Parameters:

Name Type Default
doc Node -
time number 0

Returns: IBlock[]