digitalsignage.com - open source docs digitalsignage.com - open source docs

  • API Docs for Version: 1.5.118

    • APIs

    Show:

    LiveInput Class

    Defined in: _views\_components\LiveInput.js:1

    Widget to display live editor of label / input Will fire LIVE_INPUT_CHANGED on data changed and also will fire a custom event if one was give via options.customEvent Powered by the awesome validator: https://github.com/chriso/validator.js

    Constructor

    LiveInput

    () Object

    Defined in _views\_components\LiveInput.js:1

    Returns:

    Object:

    instantiated LiveInput

    Methods

    _extendValidator

    () Boolean

    Defined in _views\_components\LiveInput.js:40

    Adding our own validation rules

    Returns:

    Boolean:

    pass or fail

    _listenUp

    ()

    Defined in _views\_components\LiveInput.js:60

    Listen to up button increasing meters

    _listenUp

    (
    • i_value
    • i_announce
    • i_ignoreValidation
    )

    Defined in _views\_components\LiveInput.js:157

    Set value and announce the change only announce if set to true

    Parameters:

    • i_value String
    • i_announce Boolean
    • i_ignoreValidation Boolean

    _validated

    (
    • i_value
    )
    Array

    Defined in _views\_components\LiveInput.js:96

    Validate against all the given rules per instance

    Parameters:

    • i_value Number

    Returns:

    Array:

    status of array of error messages

    getValidator

    () Object

    Defined in _views\_components\LiveInput.js:127

    Return the validator object so caller can reference the isXXX functions as validation rules

    Returns:

    Object:

    validator object

    getValue

    () String

    Defined in _views\_components\LiveInput.js:148

    Get current input value

    Returns:

    String:

    value

    initialize

    ()

    Defined in _views\_components\LiveInput.js:14

    Constructor

    rules

    (
    • the
    )

    Defined in _views\_components\LiveInput.js:137

    Enable validation via config object

    Parameters:

    • the Object

      config objects uses a AND rule and so ALL rules must match for no error message to display. if any error we return it in the array of errors.