Home Reference Source
import MarkdownControlsTemplate from '~/template/MarkdownControlsTemplate.js'
public class | source

MarkdownControlsTemplate

Extends:

Template → MarkdownControlsTemplate

Template for a markdown control list. Default with no actions.

Constructor Summary

Public Constructor
public

constructor(source: HTMLTextArea, controls: MarkdownControl[])

Creates a markdown control list.

Member Summary

Public Members
public get

Value of the selection

Method Summary

Public Methods
public

Adds a control

public

Adds controls

public

cutEnd(count: number)

Cuts from the end of selection

public

cutStart(count: number)

Cuts from beginning of selection

public

Inserts at a the end of where the user is.

public

Inserts at a the beginning of where the user is.

public

Replaces selection with a string

public

Checks if a string leads the selection

public

Checks if a string trails the selection

Inherited Summary

From class Template
public static get

An empty template

public static

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

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

Called when the view has loaded

public

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

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

Called right before the view will appear on screen

public

Called before disappearing

Public Constructors

public constructor(source: HTMLTextArea, controls: MarkdownControl[]) source

Creates a markdown control list.

Override:

Template#constructor

Params:

NameTypeAttributeDescription
source HTMLTextArea

where md is being edited.

controls MarkdownControl[]
  • optional
  • default: []

List of control templates.

Public Members

public get selection: string source

Value of the selection

Public Methods

public addControl() source

Adds a control

public addControls(controls: MarkdownControl[]) source

Adds controls

Params:

NameTypeAttributeDescription
controls MarkdownControl[]

public cutEnd(count: number) source

Cuts from the end of selection

Params:

NameTypeAttributeDescription
count number

positive, non-zero integer of a size to cut

public cutStart(count: number) source

Cuts from beginning of selection

Params:

NameTypeAttributeDescription
count number

positive, non-zero integer of a size to cut

public insertAtSelectionEnd(string: string) source

Inserts at a the end of where the user is.

Params:

NameTypeAttributeDescription
string string

public insertAtSelectionStart(string: string) source

Inserts at a the beginning of where the user is.

Params:

NameTypeAttributeDescription
string string

public insertForSelection(string: string) source

Replaces selection with a string

Params:

NameTypeAttributeDescription
string string

public isLeading(string: string): boolean source

Checks if a string leads the selection

Params:

NameTypeAttributeDescription
string string

Return:

boolean

public isTrailing(string: string): boolean source

Checks if a string trails the selection

Params:

NameTypeAttributeDescription
string string

Return:

boolean