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

public class | source

ModalViewTemplate

Extends:

Template → ModalViewTemplate

Direct Subclass:

FollowModalTemplate

Wrapper for modal templates. Subclass this. Prefer this over the legacy ModalTemplate

Constructor Summary

Public Constructor
public	constructor(body: Template \| Element, options: Object)

Member Summary

Public Members
public	body: Element This body instance
public	controller: ModalViewController Available when mounted
public set	requestedWidth: number Sets the requested width of the modal.
public	subtitle: string Reactive subtitle
public	title: string Reactive 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

Public Constructors

public constructor(body: Template | Element, options: Object) source

Creates a template from some form of HTML fragment. This can be from the DOM or a JS-based HTMLElement

Override:

Template#constructor

Params:

Name	Type	Attribute	Description
body	Template \| Element	nullable: true	You can either compose this or subclass it with HTMLElement. Ommitable in which case an empty div will be root (useful when subclassing).
options	Object
options.title	string		The primary title
options.subtitle	string	nullable: true	If null then cannot add later
options.requestedWidth	number		The width to attempt to make modal

Public Members

public body: Element source

This body instance

public controller: ModalViewController source

Available when mounted

public set requestedWidth: number source

Sets the requested width of the modal.

public subtitle: string source

Reactive subtitle

public title: string source

Reactive title