core/local/inplace_editable/events

Description:

  • Inplace editable module events

Source:
Copyright:
  • 2021 Paul Holden
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Inplace editable module events

Members

(static, constant) eventTypes

Description:

  • Module events

Source:
Properties:
Name Type Description
elementUpdated String

See event:core/inplace_editable:updated
elementUpdateFailed String

See event:core/inplace_editable:updateFailed

Module events

Methods

(static) notifyElementUpdateFailed(element, exception, newvalue) → {CustomEvent}

Description:

  • Notify element of failed update

Source:
Parameters:
Name Type Description
element HTMLElement

The element that failed to update
exception Object

The raised exception
newvalue String

The intended value of the element
Fires:
Returns:
Type
CustomEvent

(static) notifyElementUpdated(element, ajaxreturn, oldvalue) → {CustomEvent}

Description:

  • Notify element of successful update

Source:
Parameters:
Name Type Description
element HTMLElement

The element that was updated
ajaxreturn Object

The data returned from the update AJAX request
oldvalue String

The previous value of the element
Fires:
Returns:
Type
CustomEvent

Events

core/inplace_editable:updateFailed

Description:

  • Event triggered when an element update has failed

Source:
Properties:
Name Type Description
target HTMLElement

The element that failed to update
detail Object
Properties
Name Type Description
exception Object

The raised exception
newvalue String

The intended value of the element
Type:
  • CustomEvent

core/inplace_editable:updated

Description:

  • Event triggered when an element has been updated

Source:
Properties:
Name Type Description
target HTMLElement

The element that was updated
detail Object
Properties
Name Type Description
ajaxreturn Object

The data returned from the update AJAX request
oldvalue String

The previous value of the element
Type:
  • CustomEvent