Drupal javascript API documentation

active-link.es6.js

Source:

active-link.es6.js, line 1

Attaches behaviors for Drupal's active link marking.

ajax.es6.js

Source:

ajax.es6.js, line 1

Provides Ajax page updating via jQuery $.ajax. Ajax is a method of making a request via JavaScript while viewing an HTML page. The request returns an array of commands encoded in JSON, which is then executed to make any changes that are necessary to the page. Drupal uses this file to enhance form elements with `#ajax['url']` and `#ajax['wrapper']` properties. If set, this file will automatically be included to provide Ajax capabilities.

announce.es6.js

Source:

announce.es6.js, line 1

Adds an HTML element and method to trigger audio UAs to read system messages. Use Drupal.announce to indicate to screen reader users that an element on the page has changed state. For instance, if clicking a link loads 10 more items into a list, one might announce the change like this.

Example

$('#search-list')
  .on('itemInsert', function (event, data) {
    // Insert the new items.
    $(data.container.el).append(data.items.el);
    // Announce the change to the page contents.
    Drupal.announce(Drupal.t('@count items added to @container',
      {'@count': data.items.length, '@container': data.container.title}
    ));
  });

autocomplete.es6.js

Source:

autocomplete.es6.js, line 1

Autocomplete based on jQuery UI.

batch.es6.js

Source:

batch.es6.js, line 1

Drupal's batch API.

checkbox.es6.js

Source:

checkbox.es6.js, line 1

Defines checkbox theme functions.

collapse.es6.js

Source:

collapse.es6.js, line 1

Polyfill for HTML5 details elements.

date.es6.js

Source:

date.es6.js, line 1

Polyfill for HTML5 date input.

debounce.es6.js

Source:

debounce.es6.js, line 1

Adapted from underscore.js with the addition Drupal namespace.

details-aria.es6.js

Source:

details-aria.es6.js, line 1

Add aria attribute handling for details and summary elements.

details-summarized-content.es6.js

Source:

details-summarized-content.es6.js, line 1

Adds a summary of a details element's contents to its summary element.

displace.es6.js

Source:

displace.es6.js, line 1

Manages elements that can offset the size of the viewport. Measures and reports viewport offset dimensions from elements like the toolbar that can potentially displace the positioning of other elements.

drupal.es6.js

Source:

drupal.es6.js, line 1

Defines the Drupal JavaScript API.

drupalSettingsLoader.es6.js

Source:

drupalSettingsLoader.es6.js, line 1

Parse inline JSON and initialize the drupalSettings global object.

entity-form.es6.js

Source:

entity-form.es6.js, line 1

Defines JavaScript behaviors for the block_content module.

form.es6.js

Source:

form.es6.js, line 1

Form features.

jquery.cookie.shim.es6.js

Source:

jquery.cookie.shim.es6.js, line 1

Defines a backwards-compatible shim for jquery.cookie.

jquery.once.bc.es6.js

Source:

jquery.once.bc.es6.js, line 1

This file allows calls to `once()` and `once.remove()` to also populate the jQuery.once registry. It allows contributed code still using jQuery.once to behave as expected:

Example

once('core-once-call', 'body');

// The following will work in a contrib module still using jQuery.once:
$('body').once('core-once-call'); // => returns empty object

jquery.tabbable.shim.es6.js

Source:

jquery.tabbable.shim.es6.js, line 1

Defines a backwards-compatible shim for the jQuery UI :tabbable selector.

machine-name.es6.js

Source:

machine-name.es6.js, line 1

Machine name functionality.

message.es6.js

Source:

message.es6.js, line 1

Message API.

modernizr-additional-tests.es6.js

Source:

modernizr-additional-tests.es6.js, line 1

Provides additional Modernizr tests.

position.es6.js

Source:

position.es6.js, line 1

See:

A modified version of jQuery UI position. Per jQuery UI's public domain license, it is permissible to run modified versions of their code. This file offers the same functionality as what is provided by jQuery UI position, but refactored to meet Drupal coding standards, and restructured so it extends jQuery core instead of jQuery UI. For most positioning needs, the core/popperjs library should be used instead of the functionality provided here. This is provided to support pre-existing code that expects the jQuery position API.