ve.RichText

ve.Component. ve.RichText

Refer to ve.Component for methods or fields inherited from this Component's parent such as .options.attributes or .element.

Single-line rich text editor with bold, italic, underline, and clear text formatting options.

BIUF stands for Bold, Italic, Underline, Formatting.

  • Functional binding: veRichText().
Constructor:
  • arg0_value: string - The HTML content to initialise the component with.
  • arg1_options: Object
    • .disabled=false: boolean - Controls the .readonly attribute.
Instance:
  • .v: string - Returns an HTML string.
Methods:
  • handleBIUF(arg0_biuf_el:HTMLElement)
  • initBIUFToolbar()
  • sendOnchangeEvent()

Constructor

new ve.RichText()

Source:

Extends

Members

v :string

Returns the current HTML content in the present Component.

  • Accessor of ve.RichText
Source:
Type:
  • string

v

Sets the HTML content value for ve.RichText

  • Accessor of ve.RichText
Source:

from_binding

Internal .from_binding setter for handling .options.from_binding. Accepts a string literal that is then parsed to a variable reference.

.to_binding counterparts are manually handled child-side.

Overrides:
Source:

limit

Tests the current this.limit by calling this.limit_function(this.v, this). Otherwise resolves to true if no .options.limit is set.

Overrides:
Source:

name

Returns the visual name of the present ve.Component,

Overrides:
Source:

Methods

handleBIUF(arg0_biuf_el)

Initialises all event handlers for BIUF buttons and keybinds.

  • Method of: ve.RichText
Source:
Parameters:
Name Type Description
arg0_biuf_el HTMLElement

The mounted BIUF element.

initBIUFToolbar()

Initialises the present BIUF toolbar.

  • Method of: ve.RichText
Source:

sendOnchangeEvent()

Fires an onuserchange event whilst synchronising the present value.

  • Method of: ve.RichText
Source:

addComponent()

Adds the current component to this.parent_el should it exist.

Overrides:
Source:

bind(arg0_container_el)

Manually binds/mounts the present ve.Component into the visual DOM.

Overrides:
Source:
Parameters:
Name Type Description
arg0_container_el HTMLElement

fireFromBinding()

Pseudo-setter from binding. Fires only upon program-driven changes to .v directly, which means that this has to be monitored manually component-side in set v(). This should always come last in set v().

Overrides:
Source:

fireToBinding()

Pseudo-setter to binding. Fires only upon user-driven changes, which means that this has to be monitored manually component-side.

Overrides:
Source:

remove()

Removes the component/element from the DOM.

Overrides:
Source:

removeComponent()

Removes the current component from this.parent_el should it exist.

Overrides:
Source:

setOwner(arg0_value, arg1_owner_array)

Sets the root parent and ownership tree. Influences this.parent_el, this.owner, this.owners.

Overrides:
Source:
Parameters:
Name Type Description
arg0_value
arg1_owner_array

setValueFromObject(arg0_object, arg1_object)

Destructures Object values and transfers them into the .v instance fields of each Vercengen component.

Overrides:
Source:
Parameters:
Name Type Description
arg0_object Object

The Vercengen object to transfer to.
arg1_object Object

The other object to transfer from.