core_form/events

Javascript events for the core_form subsystem.

Source:

lib/form/amd/src/events.js, line 16

Since:

3.10

Copyright:

2021 Huong Nguyen

License:

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Example

Example of listening to a form event.

import {eventTypes as formEventTypes} from 'core_form/events';

document.addEventListener(formEventTypes.formSubmittedByJavascript, e => {
    window.console.log(e.target); // The form that was submitted.
    window.console.log(e.detail.skipValidation); // Whether form validation was skipped.
});

Members

(static, constant) eventTypes

Source:

lib/form/amd/src/events.js, line 61

Properties:

Name	Type	Description
`formError`	String	See event:core_form/error
`formFieldValidationFailed`	String	See event:core_form/fieldValidationFailed
`formSubmittedByJavascript`	String	See event:core_form/submittedByJavascript
`uploadChanged`	String	See event:core_form/uploadChanged

Events for core_form.

(static, constant) types

Source:

lib/form/amd/src/events.js, line 260

Deprecated:

since Moodle 4.0. See eventTypes instead.

List of the events.

Methods

(static) notifyFormSubmittedByJavascript(form, skipValidation, fallbackHandled) → {CustomEvent}

Source:

lib/form/amd/src/events.js, line 146

Trigger an event to indiciate that a form was submitted by Javascript.

Parameters:

Name	Type	Description
`form`	HTMLElement	The form that was submitted
`skipValidation`	Boolean	Submit the form without validation. E.g. "Cancel".
`fallbackHandled`	Boolean	The legacy YUI event has been handled

Fires:

event:formSubmittedByJavascript

Returns:

Type: CustomEvent

(static) notifyUploadChanged(elementId) → {CustomEvent}

Source:

lib/form/amd/src/events.js, line 334

Trigger an event to notify the file upload field has been changed.

Parameters:

Name	Type	Description
`elementId`	string	The element which was changed

Fires:

event:uploadChanged

Returns:

Type: CustomEvent

(static) notifyUploadCompleted(elementId) → {CustomEvent}

Source:

lib/form/amd/src/events.js, line 218

Trigger an event to indicate that an upload was completed.

Parameters:

Name	Type	Description
`elementId`	String	The element which was uploaded to

Fires:

event:uploadCompleted

Returns:

Type: CustomEvent

(static) notifyUploadStarted(elementId) → {CustomEvent}

Source:

lib/form/amd/src/events.js, line 195

Trigger an event to indicate that an upload was started.

Parameters:

Name	Type	Description
`elementId`	String	The element which was uploaded to

Fires:

event:uploadStarted

Returns:

Type: CustomEvent

(static) triggerUploadCompleted(elementId) → {CustomEvent}

Source:

lib/form/amd/src/events.js, line 253

Deprecated:

Since Moodle 4.0 See notifyUploadCompleted

Trigger upload complete event.

Parameters:

Name	Type	Description
`elementId`	String

Fires:

event:uploadCompleted

Returns:

Type: CustomEvent

(static) triggerUploadStarted(elementId) → {CustomEvent}

Source:

lib/form/amd/src/events.js, line 242

Deprecated:

Since Moodle 4.0 See notifyUploadStarted

Trigger upload start event.

Parameters:

Name	Type	Description
`elementId`	String

Fires:

event:uploadStarted

Returns:

Type: CustomEvent

(inner) changesMadeCheck(e)

Source:

lib/form/amd/src/events.js, line 46

Prevent user navigate away when upload progress still running.

Parameters:

Name	Type	Description
`e`	Event	The event

(inner) notifyFieldValidationFailure(field, message) → {CustomEvent}

Source:

lib/form/amd/src/events.js, line 167

Trigger an event to indicate that a form field contained an error.

Parameters:

Name	Type	Description
`field`	HTMLElement	The field which failed validation
`message`	String	The message displayed

Fires:

event:formFieldValidationFailed

Returns:

Type: CustomEvent

(inner) notifyFormError(field) → {CustomEvent}

Source:

lib/form/amd/src/events.js, line 126

Trigger an event to indicate that a form field contained an error.

Parameters:

Name	Type	Description
`field`	HTMLElement	The form field causing the error

Fires:

event:formError

Returns:

Type: CustomEvent

Events

core_form/fieldValidationFailed

Source:

lib/form/amd/src/events.js, line 83

Properties:

Name Type Description

target

HTMLElement

The field that failed validation

detail

object

Properties

Name	Type	Description
`message`	String	The message displayed upon failure

An event triggered upon form field validation failure.

Type:

CustomEvent

core_form/submittedByJavascript

Source:

lib/form/amd/src/events.js, line 71

Properties:

Name Type Description

target

HTMLElement

The form that was submitted

detail

object

Properties

Name	Type	Description
`skipValidation`	boolean	Whether the form was submitted without validation (i.e. via a Cancel button)
`fallbackHandled`	boolean	Whether the legacy YUI event has been handled

An event triggered when an mform is about to be submitted via javascript.

Type:

CustomEvent

core_form/uploadChanged

Source:

lib/form/amd/src/events.js, line 112

Properties:

Name	Type	Description
`target`	HTMLElement	The form field which was changed

An event triggered when a file upload field has been changed.

Type:

CustomEvent

core_form/uploadCompleted

Source:

lib/form/amd/src/events.js, line 103

Properties:

Name	Type	Description
`target`	HTMLElement	The location where the upload completed

An event triggered when an upload completes

Type:

CustomEvent

core_form/uploadStarted

Source:

lib/form/amd/src/events.js, line 94

Properties:

Name	Type	Description
`target`	HTMLElement	The location where the upload began

An event triggered when an upload is started

Type:

CustomEvent

formError

Source:

lib/form/amd/src/events.js, line 62

Properties:

Name	Type	Description
`target`	HTMLElement	The form field which errored

An event triggered when a form contains an error

Type:

CustomEvent