Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Text

Data bound text elements.

Wired to <span>, <p>, <div>, <i> and <b> tags with a data-action attribute specifying the action name.

Hierarchy

Index

Constructors

constructor

Properties

actionName

actionName: string

idCount

idCount: number

node

wireSignal

wireSignal: string | object

Static idCounter

idCounter: number = 0

Methods

actionFormat

  • actionFormat(value: any): any
  • Formats the payload of an action.

    Parameters

    • value: any

      Original payload.

    Returns any

    Modified payload.

determineActionName

  • determineActionName(node: HTMLElement): string
  • Determine the name of the action that should be associated with the node.

    The action name is determined from the tag's data-action, name or id attribute (in that order).

    Parameters

    • node: HTMLElement

      A HTML element.

    Returns string

    Name of action or null.

determineWireSignal

  • determineWireSignal(node: HTMLElement): string | object
  • Determine the name of the signal that should be listened to from the backend.

    The signal name is determined from the data-signal, data-action, name or id attribute (in that order.) For all attributes apart from data-signal, the value is wrapped in an object like { data: value-of-attribute }. The data-signal value can contain a : which will be used to create an object as well. That means that data-signal="data:myvalue" gives the same result as data-action="myvalue".

    Parameters

    • node: HTMLElement

      A HTML element.

    Returns string | object

    Name of a signal or null.

formatFn

  • formatFn(value: any): string
  • Format the value.

    The default implementation returns a JSON.stringify() version for values that are typeof value == 'object'. Otherwise it passes the value through.

    Parameters

    • value: any

      Value as represented in the backend.

    Returns string

    Formatted representation of the value.

getValue

  • getValue(): string
  • Reads the value.

    Returns string

setValue

  • setValue(v?: undefined | string): Text
  • Reads the value.

    Parameters

    • Optional v: undefined | string

    Returns Text

Static skipWire

  • skipWire(node: HTMLElement): boolean
  • Determine whether to skip this element.

    This can be forced by adding a data-skipwire=true attribute to the HTML tag.

    Parameters

    • node: HTMLElement

      A HTML element.

    Returns boolean

Static wire

  • wire(conn: Connection, root?: Document | HTMLElement): void
  • Wire all text.

    Parameters

    • conn: Connection

      Connection to use.

    • Optional root: Document | HTMLElement

    Returns void

Generated using TypeDoc