Class ParsoidDocument

A class containing an HTMLIFrameElement along with helper functions to make manipulation easier.

Hierarchy

EventTarget
- ParsoidDocument

Constructors

`Protected` constructor

new ParsoidDocument(): ParsoidDocument
Create a new ParsoidDocument instance.

Returns ParsoidDocument
Overrides EventTarget.constructor
- Defined in ParsoidDocument.module.ts:520

Properties

`Protected` $document

$document: JQuery<Document>

The JQuery (window.$) object of the iframe.

`Protected` document

document: Document

The Document object of the iframe.

`Protected` elementIndex

elementIndex: {
[key: string]: HTMLElement[];
}

A set of element arrays indexed by their MediaWiki RDFa type. For example, this array may include the key "Transclusion" from the RDFa type "mw:Transclusion".

Type declaration

[key: string]: HTMLElement[]

`Protected` etag

etag: string

The ETag of the loaded Parsoid document.

`Protected` fromExisting

fromExisting: boolean

true if the page exists on the wiki.

`Protected` iframe

iframe: HTMLIFrameElement

The frame element used by this ParsoidDocument instance.

`Protected` observer

observer: MutationObserver

A MutationObserver that watches the document for DOM changes.

`Protected` page

page: string

The page currently loaded.

`Protected` restBaseUri

restBaseUri: string

A relative URI to the root of the RESTBase instance that the page was loaded from.

`Protected` revision

revision: number

The current revision. Only set if fromPage/loadPage was used.

`Static` `Readonly` Node

Node: typeof ParsoidTransclusionTemplateNode = ParsoidTransclusionTemplateNode

`Static` blankDocument

blankDocument: string = '<html><body><section data-mw-section-id="0"></section></body></html>'

A blank Parsoid document, with a section 0.

`Static` defaultDocument

defaultDocument: string = ParsoidDocument.blankDocument

The default document to create if a page was not found.

Accessors

redirect

get redirect(): boolean
Returns boolean
true if the page is a redirect. false if otherwise.
- Defined in ParsoidDocument.module.ts:512

Methods

buildIndex

buildIndex(): void
Constructs the ParsoidDocument#elementIndex from the current document.

Returns void
- Defined in ParsoidDocument.module.ts:831

destroy

destroy(): void
Destroys the frame and pops it off of the DOM (if inserted). Silently fails if the frame has not yet been built.

Returns void
- Defined in ParsoidDocument.module.ts:784

destroyParsoidNode

destroyParsoidNode(element): void
Deletes all elements that have the same about attribute as the given element. This effectively deletes an element, be it a transclusion set, file, section, or otherwise.
Parameters
- element: HTMLElement
Returns void
- Defined in ParsoidDocument.module.ts:959

findParsoidNode

findParsoidNode(element): HTMLElement
Finds the element with the "data-mw" attribute containing the element passed into the function.
Parameters
- element: HTMLElement
  
  The element to find the parent of. This must be a member of the ParsoidDocument's document.
Returns HTMLElement
The element responsible for showing the given element.
- Defined in ParsoidDocument.module.ts:922

findTemplate

findTemplate(templateName, hrefMode?): ParsoidTransclusionTemplateNode[]
Finds a template in the loaded document.
Parameters
- templateName: string | RegExp
  
  The name of the template to look for.
- hrefMode: boolean = false
  
  Use the href instead of the wikitext to search for templates.
Returns ParsoidTransclusionTemplateNode[]
A list of elements.
- Defined in ParsoidDocument.module.ts:867

getDocument

getDocument(): Document
Get the Document object of this ParsoidDocument.

Returns Document
ParsoidDocument#document
- Defined in ParsoidDocument.module.ts:1009

getElementIndex

getElementIndex(): {
[p: string]: HTMLElement[];
}
Get the element index of this ParsoidDocument.

Returns {
[p: string]: HTMLElement[];
}
ParsoidDocument#elementIndex
- [p: string]: HTMLElement[]
- Defined in ParsoidDocument.module.ts:1041

getIframe

getIframe(): HTMLIFrameElement
Get the IFrame element of this ParsoidDocument.

Returns HTMLIFrameElement
ParsoidDocument#iframe
- Defined in ParsoidDocument.module.ts:1025

getJQuery

getJQuery(): JQuery<Document>
Get the JQuery object associated with this ParsoidDocument.

Returns JQuery<Document>
ParsoidDocument#$document
- Defined in ParsoidDocument.module.ts:1017

getNodeElements

getNodeElements(node): HTMLElement[]
Get HTML elements that are associated to a specific Parsoid node using its about attribute.
Parameters
- node: HTMLElement | ParsoidTransclusionTemplateNode
  
  The node to get the elements of
Returns HTMLElement[]
All elements that match the about of the given node.
- Defined in ParsoidDocument.module.ts:942

getPage

getPage(): string
Get the page name of the currently-loaded page.

Returns string
ParsoidDocument#page
- Defined in ParsoidDocument.module.ts:1033

`Protected` getRequestOptions

getRequestOptions(): Omit<RequestInit, "body" | "method" | "cache">
Protected
Get additional request options to be patched onto RESTBase API calls. Extend this class to modify this.

Returns Omit<RequestInit, "body" | "method" | "cache">
- Defined in ParsoidDocument.module.ts:501

getSection

getSection(id): HTMLElement
Gets the <section> HTMLElement given a section ID.
Parameters
- id: number
  
  The ID of the section
Returns HTMLElement
The HTMLElement of the section. If the section cannot be found, null.
- Defined in ParsoidDocument.module.ts:857

isFromExisting

isFromExisting(): boolean
Check if this element exists on-wiki or not.

Returns boolean
ParsoidDocument#fromExisting
- Defined in ParsoidDocument.module.ts:1049

loadHTML

loadHTML(page, html, restBaseUri?): Promise<void>
Load a document from HTML.
Parameters
- page: string
  
  The loaded page's name.
- html: string
  
  The page's HTML.
- Optional restBaseUri: string
  
  A relative or absolute URI to the wiki's RESTBase root.
Returns Promise<void>
- Defined in ParsoidDocument.module.ts:764

loadPage

loadPage(page, revision?, options?): Promise<void>
Loads a wiki page with this ParsoidDocument.
Parameters
- page: string
  
  The page to load.
- revision: number = null
  
  The revision ID of the page to load
- options: {
      allowMissing?: boolean;
      followRedirects?: boolean;
      reload?: boolean;
      requestOptions?: RequestInit;
      restBaseUri?: string;
  } = {}
  
  Options for frame loading.
  - Optional allowMissing?: boolean
    
    Set to false to avoid loading a blank document if the page does not exist.
  - Optional followRedirects?: boolean
    
    Whether to follow page redirects or not.
  - Optional reload?: boolean
    
    Whether the current page should be discarded and reloaded.
  - Optional requestOptions?: RequestInit
    
    Options to pass to the fetch request.
  - Optional restBaseUri?: string
    
    A relative or absolute URI to the wiki's RESTBase root. This is /api/rest_ by default, though the window.restBaseRoot variable can modify it.
Returns Promise<void>
- Defined in ParsoidDocument.module.ts:670

loadWikitext

loadWikitext(page, wikitext, restBaseUri): Promise<void>
Load a document from wikitext.
Parameters
- page: string
  
  The page title of this document.
- wikitext: string
  
  The wikitext to load.
- restBaseUri: string
Returns Promise<void>
- Defined in ParsoidDocument.module.ts:726

notifyLoadError

notifyLoadError(error): void
Notify the user of a document loading error.
Parameters
- error: Error
  
  An error object.
Returns void
- Defined in ParsoidDocument.module.ts:631

reload

reload(): Promise<void>
Reloads the page. This will destroy any modifications made to the document.

Returns Promise<void>
- Defined in ParsoidDocument.module.ts:794

reset

reset(): void
Clears the frame for a future reload. This will later permit loadPage and other related functions to run without the reload option.

Returns void
- Defined in ParsoidDocument.module.ts:806

setupJquery

setupJquery($doc): JQuery<Document>
Set up a JQuery object for this window.
Parameters
- $doc: JQuery<Document>
  
  The JQuery object to set up.
Returns JQuery<Document>
The JQuery object.
- Defined in ParsoidDocument.module.ts:581

toWikitext

toWikitext(): Promise<string>
Converts the contents of this document to wikitext.

Returns Promise<string>
The wikitext of this document.
- Defined in ParsoidDocument.module.ts:974

`Static` fromBlank

fromBlank(page, restBaseUri?): Promise<ParsoidDocument>
Creates a new ParsoidDocument from a blank page.
Parameters
- page: string
  
  The name of the page.
- Optional restBaseUri: string
Returns Promise<ParsoidDocument>
- Defined in ParsoidDocument.module.ts:476

`Static` fromHTML

fromHTML(page, html, restBaseUri?, wrap?): Promise<ParsoidDocument>
Create a new ParsoidDocument instance from plain HTML.
Parameters
- page: string
  
  The name of the page.
- html: string
  
  The HTML to use.
- Optional restBaseUri: string
  
  The relative URI to the RESTBase instance to be used for transforms.
- wrap: boolean = true
  
  Set to false to avoid wrapping the HTML within the body.
Returns Promise<ParsoidDocument>
- Defined in ParsoidDocument.module.ts:452

`Static` fromPage

fromPage(page, revision?, options?): Promise<ParsoidDocument>
Create a new ParsoidDocument instance from a page on-wiki.
Parameters
- page: string
  
  The page to load.
- revision: number = null
  
  The revision ID of the page to load
- options: {
      allowMissing?: boolean;
      followRedirects?: boolean;
      reload?: boolean;
      requestOptions?: RequestInit;
      restBaseUri?: string;
  } = {}
  
  Options for frame loading.
  - Optional allowMissing?: boolean
    
    Set to false to avoid loading a blank document if the page does not exist.
  - Optional followRedirects?: boolean
  - Optional reload?: boolean
    
    Whether the current page should be discarded and reloaded.
  - Optional requestOptions?: RequestInit
  - Optional restBaseUri?: string
Returns Promise<ParsoidDocument>
- Defined in ParsoidDocument.module.ts:434

`Static` fromWikitext

fromWikitext(page, wikitext, restBaseUri?): Promise<ParsoidDocument>
Creates a new ParsoidDocument from wikitext.
Parameters
- page: string
  
  The page of the document.
- wikitext: string
  
  The wikitext to load.
- Optional restBaseUri: string
Returns Promise<ParsoidDocument>
- Defined in ParsoidDocument.module.ts:489

Class ParsoidDocument

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Returns ParsoidDocument

Properties

Protected $document

Protected document

Protected elementIndex

Type declaration

[key: string]: HTMLElement[]

Protected etag

Protected fromExisting

Protected iframe

Protected observer

Protected page

Protected restBaseUri

Protected revision

Static Readonly Node

Static blankDocument

Static defaultDocument

Accessors

redirect

Returns boolean

Methods

buildIndex

Returns void

destroy

Returns void

destroyParsoidNode

Parameters

element: HTMLElement

Returns void

findParsoidNode

Parameters

element: HTMLElement

Returns HTMLElement

findTemplate

Parameters

templateName: string | RegExp

hrefMode: boolean = false

Returns ParsoidTransclusionTemplateNode[]

getDocument

Returns Document

getElementIndex

Returns { [p: string]: HTMLElement[]; }

[p: string]: HTMLElement[]

getIframe

Returns HTMLIFrameElement

getJQuery

Returns JQuery<Document>

getNodeElements

Parameters

node: HTMLElement | ParsoidTransclusionTemplateNode

Returns HTMLElement[]

getPage

Returns string

Protected getRequestOptions

Returns Omit<RequestInit, "body" | "method" | "cache">

getSection

Parameters

id: number

Returns HTMLElement

isFromExisting

Returns boolean

loadHTML

Parameters

page: string

html: string

Optional restBaseUri: string

Returns Promise<void>

loadPage

Parameters

page: string

revision: number = null

`Protected` constructor

`Protected` $document

`Protected` document

`Protected` elementIndex

`Protected` etag

`Protected` fromExisting

`Protected` iframe

`Protected` observer

`Protected` page

`Protected` restBaseUri

`Protected` revision

`Static` `Readonly` Node

`Static` blankDocument

`Static` defaultDocument

Returns {
[p: string]: HTMLElement[];
}

`Protected` getRequestOptions

`Optional` restBaseUri: string

options: {
allowMissing?: boolean;
followRedirects?: boolean;
reload?: boolean;
requestOptions?: RequestInit;
restBaseUri?: string;
} = {}

`Optional` allowMissing?: boolean

`Optional` followRedirects?: boolean

`Optional` reload?: boolean

`Optional` requestOptions?: RequestInit

`Optional` restBaseUri?: string

`Static` fromBlank

`Optional` restBaseUri: string

`Static` fromHTML

`Optional` restBaseUri: string

`Static` fromPage

options: {
allowMissing?: boolean;
followRedirects?: boolean;
reload?: boolean;
requestOptions?: RequestInit;
restBaseUri?: string;
} = {}

`Optional` allowMissing?: boolean

`Optional` followRedirects?: boolean

`Optional` reload?: boolean

`Optional` requestOptions?: RequestInit

`Optional` restBaseUri?: string

`Static` fromWikitext

`Optional` restBaseUri: string