Namespace: behaviors

Drupal.behaviors

Holds all initialization methods.

Source:

Members

Append is-active class.

The link is only active if its path corresponds to the current path, the language of the linked path is equal to the current language, and if the query parameters of the link equal those of the current request, since the same request with different query parameters may yield a different page (e.g. pagers, exposed View filters).

Does not discriminate based on element type, so allows you to set the is-active class on any element: a, li…

Type:
Source:

(static) addItemForm :Drupal~behavior

Adds functionality for the add item form.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the functionality in Drupal.viewsUi.AddItemForm to the forms in question.
Source:

(static) AJAX :Drupal~behavior

Attaches the Ajax behavior to each Ajax form element.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Initialize all Drupal.Ajax objects declared in drupalSettings.ajax or initialize Drupal.Ajax objects from DOM elements having the use-ajax-submit or use-ajax css class.
detach Drupal~behaviorDetach

During unload remove all Drupal.Ajax objects related to the removed content.
Source:

(static) autocomplete :Drupal~behavior

Attaches the autocomplete behavior to all required fields.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the autocomplete behaviors.
detach Drupal~behaviorDetach

Detaches the autocomplete behaviors.
Source:

(static) batch :Drupal~behavior

Attaches the batch behavior to progress bars.

Type:
Source:

(static) blockDrag :Drupal~behavior

Move a block in the blocks table between regions via select list.

This behavior is dependent on the tableDrag behavior, since it uses the objects initialized in that behavior to update the row.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the tableDrag behavior for blocks in block administration.
Source:

(static) blockFilterByText :Drupal~behavior

Filters the block list by a text input search string.

The text input will have the selector input.block-filter-text.

The target element to do searching in will be in the selector input.block-filter-text[data-element]

The text source where the text should be found will have the selector .block-filter-text-source

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the behavior for the block filtering.
Source:

(static) blockHighlightPlacement :Drupal~behavior

Highlights the block that was just placed into the block listing.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the behavior for the block placement highlighting.
Source:

(static) blockSettingsSummary :Drupal~behavior

Provide the summary information for the block settings vertical tabs.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the behavior for the block settings summaries.
Source:

(static) bookDetailsSummaries :Drupal~behavior

Adds summaries to the book outline form.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches summary behavior to book outline forms.
Source:

(static) ckeditorAdmin :Drupal~behavior

Sets config behavior and creates config views for the CKEditor toolbar.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches admin behavior to the CKEditor buttons.
detach Drupal~behaviorDetach

Detaches admin behavior from the CKEditor buttons on 'unload'.
Source:

(static) ckeditorAdminButtonPluginSettings :Drupal~behavior

Automatically shows/hides settings of buttons-only CKEditor plugins.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches show/hide behavior to Plugin Settings buttons.
Source:

(static) ckeditorDrupalImageSettingsSummary :Drupal~behavior

Provides the summary for the "drupalimage" plugin settings vertical tab.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches summary behavior to the "drupalimage" settings vertical tab.
Source:

(static) ckeditorLanguageSettingsSummary

Provides the summary for the "language" plugin settings vertical tab.

Source:

(static) ckeditorStylesComboSettings :Drupal~behavior

Ensures that the "stylescombo" button's metadata remains up-to-date.

Triggers the CKEditorPluginSettingsChanged event whenever the "stylescombo" plugin settings change, to ensure that the corresponding feature metadata is immediately updated — i.e. ensure that HTML tags and classes entered here are known to be "required", which may affect filter settings.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches admin behavior to the "stylescombo" button.
Source:

(static) ckeditorStylesComboSettingsSummary :Drupal~behavior

Provides the summary for the "stylescombo" plugin settings vertical tab.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches summary behavior to the plugin settings vertical tab.
Source:

(static) claroDetails :Drupal~behavior

Workaround for Firefox.

Firefox applies the focus state only for keyboard navigation. We have to manually trigger focus to make the behavior consistent across browsers.

Type:
Source:

(static) claroDetailsToggleShim :Drupal~behavior

Workaround for non-supporting browsers.

This shim extends HTML5 Shiv used by core.

HTML5 Shiv toggles focused details for hitting enter. We copy that for space key as well to make the behavior consistent across browsers.

Type:
Source:

(static) claroVerticalTabs :Drupal~behavior

This script transforms a set of details into a stack of vertical tabs.

Each tab may have a summary which can be updated by another script. For that to work, each details element has an associated 'verticalTabCallback' (with jQuery.data() attached to the details), which is called every time the user performs an update to a form element inside the tab pane.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behaviors for vertical tabs.
Source:

(static) ClickToSelect :Drupal~behavior

Allows users to select an element which checks a hidden checkbox.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior for selecting media library item.
Source:

(static) collapse :Drupal~behavior

Polyfill HTML5 details element.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior for the details element.
Source:

(static) color :Drupal~behavior

Displays farbtastic color selector and initialize color administration UI.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attach color selection behavior to relevant context.
Source:

(static) commentByViewer :Drupal~behavior

Add 'by-viewer' class to comments written by the current user.

Type:
Source:

(static) commentFieldsetSummaries :Drupal~behavior

Type:
Source:

(static) commentNewIndicator :Drupal~behavior

Renders "new" comment indicators wherever necessary.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches "new" comment indicators behavior.
Source:

(static) contentTranslation :Drupal~behavior

Makes field translatability inherit bundle translatability.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches content translation behavior.
Source:

(static) contentTranslationDependentOptions :Drupal~behavior

Forces applicable options to be checked as translatable.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches content translation dependent options to the UI.
Source:

(static) contentTypes :Drupal~behavior

Behaviors for setting summaries on content type form.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches summary behaviors on content type edit forms.
Source:

(static) contextual :Drupal~behavior

Attaches outline behavior for regions associated with contextual links.

Events Contextual triggers an event that can be used by other scripts.

  • drupalContextualLinkAdded: Triggered when a contextual link is added.
Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the outline behavior to the right context.
Source:

(static) contextualToolbar :Drupal~behavior

Attaches contextual's edit toolbar tab behavior.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches contextual toolbar behavior on a contextualToolbar-init event.
Source:

(static) copyFieldValue :Drupal~behavior

Attaches field copy behavior from input fields to other input fields.

When a field is filled out, apply its value to other fields that will likely use the same value. In the installer this is used to populate the administrator email address with the same value as the site email address.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the field copy behavior to an input field.
Source:

(static) date :Drupal~behavior

Attach datepicker fallback on date elements.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the behavior. Adds a class that hides formatting instructions on date/time fields when the browser supports a native datepicker.
Source:

(static) dateFormat :Drupal~behavior

Display the preview for date format entered.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attach behavior for previewing date formats on input elements.
Source:

(static) detailsAria :Drupal~behavior

Handles aria-expanded and aria-pressed attributes on details elements.

Type:
Source:

(static) detailsSummary :Drupal~behavior

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

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior for the details element.
Source:

(static) dialog :Drupal~behavior

Initialize dialogs for Ajax purposes.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the behaviors for dialog ajax functionality.
Source:

(static) dropButton :Drupal~behavior

Process elements with the .dropbutton class on page load.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches dropButton behaviors.
Source:

(static) drupalAnnounce :Drupal~behavior

Builds a div element with the aria-live attribute and add it to the DOM.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the behavior for drupalAnnounce.
Source:

(static) drupalDisplace :Drupal~behavior

Registers a resize handler on the window.

Type:
Source:

(static) editor :Drupal~behavior

Enables editors on text_format elements.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches an editor to an input element.
detach Drupal~behaviorDetach

Detaches an editor from an input element.
Source:

(static) entityContentDetailsSummaries :Drupal~behavior

Sets summaries about revision and translation of entities.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches summary behavior entity form tabs.

Specifically, it updates summaries to the revision information and the translation options.
Source:

(static) escapeAdmin :Drupal~behavior

Replaces the "Home" link with "Back to site" link.

Back to site link points to the last non-administrative page the user visited within the same browser tab.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the replacement functionality to the toolbar-escape-admin element.
Source:

(static) fieldUIDisplayOverview :Drupal~behavior

Attaches the fieldUIOverview behavior.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the fieldUIOverview behavior.
Source:
See:

(static) fieldUIFieldStorageAddForm :Drupal~behavior

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Adds behaviors to the field storage add form.
Source:

(static) fileAutoUpload :Drupal~behavior

Attach behaviors to file element auto upload.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches triggers for the upload button.
detach Drupal~behaviorDetach

Detaches auto file upload trigger.
Source:

(static) fileButtons :Drupal~behavior

Attach behaviors to the file upload and remove buttons.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches form submit events.
detach Drupal~behaviorDetach

Detaches form submit events.
Source:

Attach behaviors to links within managed file elements for preview windows.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches triggers.
detach Drupal~behaviorDetach

Detaches triggers.
Source:

(static) fileValidateAutoAttach :Drupal~behavior

Attach behaviors to the file fields passed in the settings.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches validation for file extensions.
detach Drupal~behaviorDetach

Detaches validation for file extensions.
Source:

(static) fillUserInfoFromBrowser :Drupal~behavior

Prepopulate form fields with information from the visitor browser.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the behavior for filling user info from browser.
Source:

(static) filterFilterHtmlUpdating :Drupal~behavior

Displays and updates what HTML tags are allowed to use in a filter.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior for updating allowed HTML tags.
Source:
To Do:
  • Remove everything but 'attach' and 'detach' and make a proper object.

(static) filterGuidelines :Drupal~behavior

Displays the guidelines of the selected text format automatically.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior for updating filter guidelines.
Source:

(static) filterStatus :Drupal~behavior

Displays and updates the status of filters on the admin page.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behaviors to the filter admin view.
Source:

(static) formSingleSubmit :Drupal~behavior

Prevents consecutive form submissions of identical form values.

Repetitive form submissions that would submit the identical form values are prevented, unless the form values are different to the previously submitted values.

This is a simplified re-implementation of a user-agent behavior that should be natively supported by major web browsers, but at this time, only Firefox has a built-in protection.

A form value-based approach ensures that the constraint is triggered for consecutive, identical form submissions only. Compared to that, a form button-based approach would (1) rely on [visible] buttons to exist where technically not required and (2) require more complex state management if there are multiple buttons in a form.

This implementation is based on form-level submit events only and relies on jQuery's serialize() method to determine submitted form values. As such, the following limitations exist:

  • Event handlers on form buttons that preventDefault() do not receive a double-submit protection. That is deemed to be fine, since such button events typically trigger reversible client-side or server-side operations that are local to the context of a form only.
  • Changed values in advanced form controls, such as file inputs, are not part of the form values being compared between consecutive form submits (due to limitations of jQuery.serialize()). That is deemed to be acceptable, because if the user forgot to attach a file, then the size of HTTP payload will most likely be small enough to be fully passed to the server endpoint within (milli)seconds. If a user mistakenly attached a wrong file and is technically versed enough to cancel the form submission (and HTTP payload) in order to attach a different file, then that edge-case is not supported here.

Lastly, all forms submitted via HTTP GET are idempotent by definition of HTTP standards, so excluded in this implementation.

Type:
Source:

(static) formUpdated :Drupal~behavior

Triggers the 'formUpdated' event on form elements when they are modified.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches formUpdated behaviors.
detach Drupal~behaviorDetach

Detaches formUpdated behaviors.
Source:
Fires:

(static) hideUpdateInformation :Drupal~behavior

Show/hide the description details on Available translation updates page.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior for toggling details on the translation update page.
Source:

(static) importLanguageCodeSelector :Drupal~behavior

Select the language code of an imported file based on its filename.

This only works if the file name ends with "LANGCODE.po".

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior for preselecting language code based on filename.
Source:

(static) initializeFilterConfiguration :Drupal~behavior

Initializes Drupal.filterConfiguration.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Gets filter configuration from filter form input.
Source:

(static) js_webassert_test_wait_for_ajax_request :Drupal~behavior

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Makes changes in the DOM to be able to test the completion of AJAX in assertWaitOnAjaxRequest.
Source:

(static) js_webassert_test_wait_for_ajax_request :Drupal~behavior

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Makes changes in the DOM to be able to test the completion of AJAX in assertWaitOnAjaxRequest.
Source:

(static) js_webassert_test_wait_for_element :Drupal~behavior

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Makes changes in the DOM to be able to test the completion of AJAX in assertWaitOnAjaxRequest.
Source:

(static) livePreview :Drupal~behavior

Trigger preview when the "live preview" checkbox is checked.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to trigger live preview if the live preview option is checked.
Source:

(static) localeTranslateDirty :Drupal~behavior

Marks changes of translations.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to show the user if translations has changed.
detach Drupal~behaviorDetach

Detach behavior to show the user if translations has changed.
Source:

(static) machineName :Drupal~behavior

Attach the machine-readable name form element behavior.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches machine-name behaviors.
Source:

(static) mediaFormSummaries :Drupal~behavior

Behaviors for summaries for tabs in the media edit form.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches summary behavior for tabs in the media edit form.
Source:

(static) MediaLibraryItemSelection :Drupal~behavior

Update the media library selection when loaded or media items are selected.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to select media items.
Source:

(static) MediaLibraryItemSelectionClaro :Drupal~behavior

Update the media library selection when loaded or media items are selected.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to select media items.
Source:

(static) MediaLibraryModalClearSelection :Drupal~behavior

Clear the current selection.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to clear the selection when the library modal closes.
Source:

(static) MediaLibrarySelectAll :Drupal~behavior

Adds checkbox to select all items in the library.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to select all media items.
Source:

(static) MediaLibraryTabs :Drupal~behavior

Load media library content through AJAX.

Standard AJAX links (using the 'use-ajax' class) replace the entire library dialog. When navigating to a media type through the vertical tabs, we only want to load the changed library content. This is not only more efficient, but also provides a more accessible user experience for screen readers.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to vertical tabs in the media library.
Source:
To Do:
  • Remove when the AJAX system adds support for replacing a specific selector via a link. https://www.drupal.org/project/drupal/issues/3026636

(static) MediaLibraryViewsDisplay :Drupal~behavior

Load media library displays through AJAX.

Standard AJAX links (using the 'use-ajax' class) replace the entire library dialog. When navigating to a media library views display, we only want to load the changed views display content. This is not only more efficient, but also provides a more accessible user experience for screen readers.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to vertical tabs in the media library.
Source:
To Do:
  • Remove when the AJAX system adds support for replacing a specific selector via a link. https://www.drupal.org/project/drupal/issues/3026636

(static) MediaLibraryWidgetDisableButton :Drupal~behavior

Disable the open button when the user is not allowed to add more items.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to disable the media library open button.
Source:

(static) MediaLibraryWidgetSortable :Drupal~behavior

Allows users to re-order their selection with drag+drop.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to re-order selected media items.
Source:

(static) MediaLibraryWidgetToggleWeight :Drupal~behavior

Allows selection order to be set without drag+drop for accessibility.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to toggle the weight field for media items.
Source:

(static) mediaTypeFormSummaries :Drupal~behavior

Behaviors for setting summaries on media type form.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches summary behaviors on media type edit forms.
Source:

(static) menuUiChangeParentItems :Drupal~behavior

Type:
Source:

(static) menuUiDetailsSummaries :Drupal~behavior

Set a summary on the menu link form.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Find the form and call drupalSetSummary on it.
Source:

(static) menuUiLinkAutomaticTitle :Drupal~behavior

Automatically fill in a menu link title, if possible.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches change and keyup behavior for automatically filling out menu link titles.
Source:

(static) messages

Getting messages from context.

Source:

(static) navTabs

Initialize the tabs JS.

Source:

(static) navTabs

Initialize the tabs JS.

Source:

(static) negotiationLanguage :Drupal~behavior

Makes language negotiation inherit user interface negotiation.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attach behavior to language negotiation admin user interface.
Source:

(static) nodeDetailsSummaries :Drupal~behavior

Behaviors for tabs in the node edit form.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches summary behavior for tabs in the node edit form.
Source:

Render "X new comments" links wherever necessary.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches new comment links behavior.
Source:

Disables all non-relevant links in node previews.

Destroys links (except local fragment identifiers such as href="#frag") in node previews to prevent users from leaving the page.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches confirmation prompt for clicking links in node preview mode.
detach Drupal~behaviorDetach

Detaches confirmation prompt for clicking links in node preview mode.
Source:

(static) nodePreviewSwitchViewMode :Drupal~behavior

Switch view mode.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches automatic submit on formUpdated.preview events.
Source:

(static) offCanvasEvents :Drupal~behavior

Attaches off-canvas dialog behaviors.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches event listeners for off-canvas dialogs.
Source:

(static) oliveroNavigation

Initialize the navigation JS.

Source:

(static) password :Drupal~behavior

Attach handlers to evaluate the strength of any password fields and to check that its confirmation is correct.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches password strength indicator and other relevant validation to password fields.
Source:

(static) passwordThemeFunctionTest :Drupal~behavior

Confirm deprecation of property in evaluatePasswordStrength() return.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches a check for the deprecated message property in the object returned by Drupal.evaluatePasswordStrength().
Source:

(static) pathDetailsSummaries :Drupal~behavior

Behaviors for settings summaries on path edit forms.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches summary behavior on path edit forms.
Source:

(static) permissions :Drupal~behavior

Shows checked and disabled checkboxes for inherited permissions.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches functionality to the permissions table.
Source:

(static) quickedit :Drupal~behavior

Type:
Source:

(static) responsiveDetails :Drupal~behavior

Initializes the responsive behaviors for details elements.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the responsive behavior to status report specific details elements.
Source:

(static) responsiveDetails :Drupal~behavior

Initializes the responsive behaviors for details elements.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the responsive behavior to status report specific details elements.
Source:

(static) responsiveImageAJAX

Call picturefill so newly added responsive images are processed.

Source:

(static) setTimezone :Drupal~behavior

Set the client's system time zone as default values of form fields.

Type:
Source:

(static) states :Drupal~behavior

Attaches the states.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches states behaviors.
Source:

(static) syncPreviewDisplay :Drupal~behavior

Sync preview display.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to sync the preview display when needed.
Source:

(static) tableDrag :Drupal~behavior

Drag and drop table rows with field manipulation.

Using the drupal_attach_tabledrag() function, any table with weights or parent relationships may be made into draggable tables. Columns containing a field may optionally be hidden, providing a better user experience.

Created tableDrag instances may be modified with custom behaviors by overriding the .onDrag, .onDrop, .row.onSwap, and .row.onIndent methods. See blocks.js for an example of adding additional functionality to tableDrag.

Type:
Source:

(static) tableDrag :Drupal~behavior

Drag and drop table rows with field manipulation.

Using the drupal_attach_tabledrag() function, any table with weights or parent relationships may be made into draggable tables. Columns containing a field may optionally be hidden, providing a better user experience.

Created tableDrag instances may be modified with custom behaviors by overriding the .onDrag, .onDrop, .row.onSwap, and .row.onIndent methods. See blocks.js for an example of adding additional functionality to tableDrag.

Type:
Source:

(static) tableDragTest :Drupal~behavior

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Removes a test class from the handle elements to allow verifying that dragging operations have been executed.
Source:

(static) tableFilterByText :Drupal~behavior

Filters the module list table by a text input search string.

Additionally accounts for multiple tables being wrapped in "package" details elements.

Text search input: input.table-filter-text Target table: input.table-filter-text[data-table] Source text: .table-filter-text-source, .module-name, .module-description

Type:
Source:

(static) tableHeader :Drupal~behavior

Attaches sticky table headers.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the sticky table header behavior.
Source:

(static) tableResponsive :Drupal~behavior

Attach the tableResponsive function to Drupal.behaviors.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches tableResponsive functionality.
Source:

(static) tableSelect :Drupal~behavior

Initialize tableSelects.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches tableSelect functionality.
Source:

(static) termDrag :Drupal~behavior

Reorder taxonomy terms.

This behavior is dependent on the tableDrag behavior, since it uses the objects initialized in that behavior to update the row.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the drag behavior to a applicable table element.
Source:

(static) textSummary :Drupal~behavior

Auto-hide summary textarea if empty and show hide and unhide links.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches auto-hide behavior on text-summary events.
Source:

(static) toggleEditMode :Drupal~behavior

Toggle the js-settings-tray-edit-mode class on items that we want to disable while in edit mode.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Toggle the js-settings-tray-edit-mode class.
Source:

(static) toolbar :Drupal~behavior

Registers tabs with the toolbar.

The Drupal toolbar allows modules to register top-level tabs. These may point directly to a resource or toggle the visibility of a tray.

Modules register tabs with hook_toolbar().

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the toolbar rendering functionality to the toolbar element.
Source:

(static) tour :Drupal~behavior

Attaches the tour's toolbar tab behavior.

It uses the query string for:

  • tour: When ?tour=1 is present, the tour will start automatically after the page has loaded.
  • tips: Pass ?tips=class in the url to filter the available tips to the subset which match the given class.
Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attach tour functionality on tour events.
Source:
Example
http://example.com/foo?tour=1&tips=bar

(static) trackerHistory

Render "new" and "updated" node indicators, as well as "X new" replies links.

Source:

(static) verticalTabs :Drupal~behavior

This script transforms a set of details into a stack of vertical tabs.

Each tab may have a summary which can be updated by another script. For that to work, each details element has an associated 'verticalTabCallback' (with jQuery.data() attached to the details), which is called every time the user performs an update to a form element inside the tab pane.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behaviors for vertical tabs.
Source:

(static) viewsAjax :Drupal~behavior

Ajax behaviors for the views_ui module.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches ajax behaviors to the elements with the classes in question.
Source:

(static) ViewsAjaxView :Drupal~behavior

Attaches the AJAX behavior to exposed filters forms and key View links.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches ajaxView functionality to relevant elements.
Source:

(static) viewsFilterConfigSelectAll :Drupal~behavior

Add a select all checkbox, which checks each checkbox at once.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches select all functionality to the views filter form.
Source:

(static) viewsModalContent :Drupal~behavior

Functionality for views modals.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches modal functionality for views.
detach Drupal~behaviorDetach

Detaches the modal functionality.
Source:

(static) viewsRemoveIconClass :Drupal~behavior

Remove icon class from elements that are themed as buttons or dropbuttons.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Removes the icon class from certain views elements.
Source:

(static) viewsUiAddView :Drupal~behavior

In the add view wizard, use the view name to prepopulate form fields such as page title and menu link.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior for prepopulating page title and menu links, based on view name.
Source:

(static) viewsUiChangeDefaultWidget :Drupal~behavior

Change the default widget to select the default group according to the selected widget for the exposed group.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Changes the default widget based on user input.
Source:

(static) viewsUiCheckboxify :Drupal~behavior

Change "Expose filter" buttons into checkboxes.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Changes buttons into checkboxes via Drupal.viewsUi.Checkboxifier.
Source:

(static) viewsUiEditView :Drupal~behavior

Improve the user experience of the views edit interface.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches toggling of SQL rewrite warning on the corresponding checkbox.
Source:

Functionality for the remove link in the views UI.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior for the remove view and remove display links.
Source:

(static) viewsUiOverrideSelect :Drupal~behavior

Change the Apply button text based upon the override select state.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches behavior to change the Apply button according to the current state.
Source:

(static) viewsUiPreview :Drupal~behavior

Preview functionality in the views edit form.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the preview functionality to the view edit form.
Source:

(static) viewsUiRearrangeFilter :Drupal~behavior

Rearranges the filters.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attach handlers to make it possible to rearrange the filters in the form in question.
Source:
See:

(static) viewsUiRenderAddViewButton :Drupal~behavior

The input field items that add displays must be rendered as <input> elements. The following behavior detaches the <input> elements from the DOM, wraps them in an unordered list, then appends them to the list of tabs.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Fixes the input elements needed.
Source:

(static) viewsUiSearchOptions :Drupal~behavior

Add search options to the views ui.

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches Drupal.viewsUi.OptionsSearch to the views ui filter options.
Source:

(static) viewTableFilterByText :Drupal~behavior

Filters the view listing tables by a text input search string.

Text search input: input.views-filter-text Target table: input.views-filter-text[data-table] Source text: [data-drupal-selector="views-table-filter-text-source"]

Type:
Properties:
Name Type Description
attach Drupal~behaviorAttach

Attaches the filter functionality to the views admin text search field.
Source: