Reference Source
import ReadmeModal from 'flarum/admin/components/ReadmeModal'
public class | source

ReadmeModal

Extends:

src/common/Component.js~ComponentModal → ReadmeModal

Member Summary

Public Members
public

extName: *

public
public

name: *

public

readme: *

Method Summary

Public Methods
public
public

content(): *

public

async loadReadme()

public

oninit(vnode: *)

public

title(): *

Inherited Summary

From class Modal
public static

Determine whether or not the modal should be dismissible via an 'x' button.

public

Attributes for an alert component to show below the header.

public
public abstract

Get the class name to apply to the modal.

public abstract

content(): VirtualElement

Get the content of the modal.

public

hide()

Hide the modal.

public

loaded()

Stop loading.

public

onbeforeremove(vnode: *): *

public

oncreate(vnode: *)

public

Show an alert describing an error returned from the API, and give focus to the first relevant field.

public

Focus on the first input when the modal is ready to be used.

public

onsubmit(e: Event)

Handle the modal form's submit event.

public abstract

Get the title of the modal dialog.

public

view(): *

Public Members

public extName: * source

public loading: boolean source

Override:

Modal#loading

public name: * source

public readme: * source

Public Methods

public className(): string source

Get the class name to apply to the modal.

Override:

Modal#className

Return:

string

public content(): * source

Get the content of the modal.

Override:

Modal#content

Return:

*

public async loadReadme() source

public oninit(vnode: *) source

Params:

NameTypeAttributeDescription
vnode *

public title(): * source

Get the title of the modal dialog.

Override:

Modal#title

Return:

*