Options
All
  • Public
  • Public/Protected
  • All
Menu

The TextEditor component displays a textarea with controls, including a submit button.

Attrs

  • composer
  • submitLabel
  • value
  • placeholder
  • disabled
  • preview

Hierarchy

Index

Constructors

constructor

Properties

attrs

The attributes passed into the component.

see

https://mithril.js.org/components.html#passing-data-to-components

disabled

disabled: any

Whether the editor is disabled.

element

element: Element

The root DOM element for the component.

state

state: undefined

Class component state that is persisted between redraws.

Updating this will not automatically trigger a redraw, unlike other frameworks.

This is different to Vnode state, which is always an instance of your class component.

This is undefined by default.

value

value: undefined | string

The value of the editor.

Methods

$

  • Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

    For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.

    final

    Parameters

    • Optional selector: string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node

buildEditor

buildEditorParams

  • buildEditorParams(): { classNames: string[]; disabled: any; inputListeners: never[]; oninput: (value: string) => void; onsubmit: () => void; placeholder: any; value: undefined | string }
  • Returns { classNames: string[]; disabled: any; inputListeners: never[]; oninput: (value: string) => void; onsubmit: () => void; placeholder: any; value: undefined | string }

    • classNames: string[]
    • disabled: any
    • inputListeners: never[]
    • oninput: (value: string) => void
        • (value: string): void
        • Handle input into the textarea.

          Parameters

          • value: string

          Returns void

    • onsubmit: () => void
        • (): void
        • Returns void

    • placeholder: any
    • value: undefined | string

controlItems

onbeforeremove

onbeforeupdate

oncreate

  • oncreate(vnode: any): void

oninit

  • oninit(vnode: any): void

oninput

  • oninput(value: string): void

onremove

onsubmit

  • onsubmit(): void

onupdate

  • onupdate(vnode: any): void

toolbarItems

view

  • view(): Element

Static component

  • component<SAttrs>(attrs?: SAttrs, children?: Children): Vnode<{}, {}>

Static initAttrs

  • initAttrs(attrs: unknown): void

Generated using TypeDoc version 0.22.10