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

public class | source

MarkdownControl

Extends:

Template → MarkdownControl

Represents a control for the markdown controls list. Stores all the information and a callback for the action.

Constructor Summary

Public Constructor
public	constructor(name: string, key: string, iconName: string, callback: Function)

Method Summary

Public Methods
public	setControllingTemplate(template: MarkdownControlsTemplate) Sets the controlling template.
public	trigger() Calls

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(name: string, key: string, iconName: string, callback: Function) 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
name	string		Name of control
key	string		Name of key to trigger keyboard shortcut.
iconName	string		Icon name (/static/img/$.svg)
callback	Function		Passed the markdown control instance.

Public Methods

public setControllingTemplate(template: MarkdownControlsTemplate) source

Sets the controlling template.

Params:

Name	Type	Attribute	Description
template	MarkdownControlsTemplate		controlling template

public trigger() source

Calls