Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextInput

Make an <input[type='text']> with an action name interactive.

Hierarchy

Index

Constructors

constructor

  • new TextInput(node: HTMLElement): TextInput

Properties

_triggerOnKeyUp

_triggerOnKeyUp: boolean

actionName

actionName: string

idCount

idCount: number

node

node: HTMLInputElement & HTMLDatabenchElement

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.

change

  • change(): void

changeCB

  • changeCB(value: any): void
  • Callback that is triggered on frontend changes.

    Parameters

    • value: any

      A formatted action.

    Returns void

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.

    Parameters

    • value: any

      Value as represented in the backend.

    Returns string

    Formatted representation of the value.

getValue

  • getValue(): string
  • Reads and sets the value.

    Returns string

setValue

triggerOnKeyUp

  • The default is false, which means that the callback is only triggered on change events (i.e. pressing enter or unfocusing the element). Setting this to true will trigger on every keyup event of this element.

    Parameters

    • v: boolean

      Whether to trigger on keyup events. Default is true.

    Returns TextInput

    self

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 inputs.

    Parameters

    • conn: Connection
    • Optional root: Document | HTMLElement

    Returns void

Generated using TypeDoc