1. Documentation
  2. API
  3. Backend
  4. FormWidgets
  5. MarkdownEditor

Backend\FormWidgets\MarkdownEditor

Overview

MarkdownEditor renders a markdown editor field.

Extends

Public Properties

public string $mode

Display mode: split, tab.

public bool $safe

Render preview with safe markdown.

public bool $legacyMode

The Legacy mode disables the Vue integration.

public bool $sideBySide

sideBySide window by default.

public string $externalToolbarAppState

Defines a mount point for the editor toolbar. Must include a module name that exports the Vue application and a state element name. Format: stateElementName Only works in Vue applications and form document layouts.

Show inherited public properties

Inherited Public Properties

Protected Properties

protected $defaultAlias

defaultAlias to identify this widget.

Show inherited protected properties

Inherited Protected Properties

Public Methods

public init()

public init(): void

init the widget, called by the constructor and free from its parameters.

public onRefresh()

public onRefresh(): void

public prepareVars()

public prepareVars(): void

prepareVars for display

public render()

public render(): void

render the widget's primary contents.

Show inherited public methods

Inherited Public Methods

Protected Methods

protected loadAssets()

protected loadAssets(): void

loadAssets adds widget specific asset files. Use $this->addJs() and $this->addCss() to register new assets to include on the page.

Show inherited protected methods

Inherited Protected Methods