import ModalTemplate from '~/template/ModalTemplate.js'

public class | source

ModalTemplate

Extends:

Template → ModalTemplate

Direct Subclass:

ImageUploadModalTemplate, LinkModalTemplate, MathEditorModalTemplate

A presentable modal view.

Static Member Summary

Static Public Members
public static get	shared: Modal Returns shared instance, only applicable for subclasses

Constructor Summary

Public Constructor
public	constructor(title: string, root: HTMLElement, type: TemplateType) Creates a modal given a reference element.

Member Summary

Public Members
public get	subtitle: string Obtains subtitle or nil
public set	subtitle: string Sets the subtitle (note: may not update until re-created)
public get	title: string Returns the modal title

Inherited Summary

From class Template
public static get	empty An empty template
public static	fromId(id: string, type: TemplateType): Template Performs a `move` TemplateType for a given HTML id to return a template based on the id's root.
public static	fromInnerHTML(wrapper: HTMLElement, innerHTML: string, type: TemplateType): Template From innerHTML will wrap in div
public static	fromText(text: string, type: TemplateType): Template Creates template `<div>` with text.
public get	underlyingNode: HTMLElement Returns the underlying element
public	defineLinkedClass(name: string, className: string, node: HTMLElement) Defines a linked class
public	defineLinkedInput(name: string, input: HTMLElement) Defines a linked input
public	defineLinkedText(name: string, defaultValue: string): Text Creates a field w/ updating text
public abstract	async didInitialLoad() Called when loaded the first time
public abstract	didLoad() Called when the view has loaded
public	didUnload() Called when disappeared
public	getParent(defaultElement: HTMLElement): HTMLElement Gets the original parent or else a default
public	loadBeforeContext(elem: HTMLElement): HTMLElement Loads before an element
public	loadInContext(parent: HTMLElement, allowDupliacte: boolean): HTMLElement Loads the template in a context
public	loadReplacingContext(source: HTMLElement): HTMLElement Loads and replaces
public	prependInContext(parent: HTMLElement, allowDupliacte: boolean): HTMLElement Prepends the template in a context
public	removeFromContext() Removes from the context.
public	unique(): HTMLElement Returns a unique instance of the template as an HTMLElement.
public	async willInitialLoad() Called before loaded the first time
public	willLoad() Called right before the view will appear on screen
public	willUnload() Called before disappearing

Static Public Members

public static get shared: Modal source

Returns shared instance, only applicable for subclasses

Public Constructors

public constructor(title: string, root: HTMLElement, type: TemplateType) source

Creates a modal given a reference element. Use Modal.shared with a subclass to get a canolical reference

Override:

Template#constructor

Params:

Name	Type	Attribute	Description
title	string		title of modal
root	HTMLElement		Root view of the template
type	TemplateType		Type of the template to reference.

Public Members

public get subtitle: string source

Obtains subtitle or nil

public set subtitle: string source

Sets the subtitle (note: may not update until re-created)

public get title: string source

Returns the modal title