123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232 |
- /**
- * @file
- * Handles AJAX fetching of views, including filter submission and response.
- */
- (function($, Drupal, drupalSettings) {
- /**
- * Attaches the AJAX behavior to exposed filters forms and key View links.
- *
- * @type {Drupal~behavior}
- *
- * @prop {Drupal~behaviorAttach} attach
- * Attaches ajaxView functionality to relevant elements.
- */
- Drupal.behaviors.ViewsAjaxView = {};
- Drupal.behaviors.ViewsAjaxView.attach = function(context, settings) {
- if (settings && settings.views && settings.views.ajaxViews) {
- const {
- views: { ajaxViews },
- } = settings;
- Object.keys(ajaxViews || {}).forEach(i => {
- Drupal.views.instances[i] = new Drupal.views.ajaxView(ajaxViews[i]);
- });
- }
- };
- Drupal.behaviors.ViewsAjaxView.detach = (context, settings, trigger) => {
- if (trigger === 'unload') {
- if (settings && settings.views && settings.views.ajaxViews) {
- const {
- views: { ajaxViews },
- } = settings;
- Object.keys(ajaxViews || {}).forEach(i => {
- const selector = `.js-view-dom-id-${ajaxViews[i].view_dom_id}`;
- if ($(selector, context).length) {
- delete Drupal.views.instances[i];
- delete settings.views.ajaxViews[i];
- }
- });
- }
- }
- };
- /**
- * @namespace
- */
- Drupal.views = {};
- /**
- * @type {object.<string, Drupal.views.ajaxView>}
- */
- Drupal.views.instances = {};
- /**
- * Javascript object for a certain view.
- *
- * @constructor
- *
- * @param {object} settings
- * Settings object for the ajax view.
- * @param {string} settings.view_dom_id
- * The DOM id of the view.
- */
- Drupal.views.ajaxView = function(settings) {
- const selector = `.js-view-dom-id-${settings.view_dom_id}`;
- this.$view = $(selector);
- // Retrieve the path to use for views' ajax.
- let ajaxPath = drupalSettings.views.ajax_path;
- // If there are multiple views this might've ended up showing up multiple
- // times.
- if (ajaxPath.constructor.toString().indexOf('Array') !== -1) {
- ajaxPath = ajaxPath[0];
- }
- // Check if there are any GET parameters to send to views.
- let queryString = window.location.search || '';
- if (queryString !== '') {
- // Remove the question mark and Drupal path component if any.
- queryString = queryString
- .slice(1)
- .replace(/q=[^&]+&?|&?render=[^&]+/, '');
- if (queryString !== '') {
- // If there is a '?' in ajaxPath, clean url are on and & should be
- // used to add parameters.
- queryString = (/\?/.test(ajaxPath) ? '&' : '?') + queryString;
- }
- }
- this.element_settings = {
- url: ajaxPath + queryString,
- submit: settings,
- setClick: true,
- event: 'click',
- selector,
- progress: { type: 'fullscreen' },
- };
- this.settings = settings;
- // Add the ajax to exposed forms.
- this.$exposed_form = $(
- `form#views-exposed-form-${settings.view_name.replace(
- /_/g,
- '-',
- )}-${settings.view_display_id.replace(/_/g, '-')}`,
- );
- this.$exposed_form
- .once('exposed-form')
- .each($.proxy(this.attachExposedFormAjax, this));
- // Add the ajax to pagers.
- this.$view
- // Don't attach to nested views. Doing so would attach multiple behaviors
- // to a given element.
- .filter($.proxy(this.filterNestedViews, this))
- .once('ajax-pager')
- .each($.proxy(this.attachPagerAjax, this));
- // Add a trigger to update this view specifically. In order to trigger a
- // refresh use the following code.
- //
- // @code
- // $('.view-name').trigger('RefreshView');
- // @endcode
- const selfSettings = $.extend({}, this.element_settings, {
- event: 'RefreshView',
- base: this.selector,
- element: this.$view.get(0),
- });
- this.refreshViewAjax = Drupal.ajax(selfSettings);
- };
- /**
- * @method
- */
- Drupal.views.ajaxView.prototype.attachExposedFormAjax = function() {
- const that = this;
- this.exposedFormAjax = [];
- // Exclude the reset buttons so no AJAX behaviors are bound. Many things
- // break during the form reset phase if using AJAX.
- $('input[type=submit], input[type=image]', this.$exposed_form)
- .not('[data-drupal-selector=edit-reset]')
- .each(function(index) {
- const selfSettings = $.extend({}, that.element_settings, {
- base: $(this).attr('id'),
- element: this,
- });
- that.exposedFormAjax[index] = Drupal.ajax(selfSettings);
- });
- };
- /**
- * @return {bool}
- * If there is at least one parent with a view class return false.
- */
- Drupal.views.ajaxView.prototype.filterNestedViews = function() {
- // If there is at least one parent with a view class, this view
- // is nested (e.g., an attachment). Bail.
- return !this.$view.parents('.view').length;
- };
- /**
- * Attach the ajax behavior to each link.
- */
- Drupal.views.ajaxView.prototype.attachPagerAjax = function() {
- this.$view
- .find(
- 'ul.js-pager__items > li > a, th.views-field a, .attachment .views-summary a',
- )
- .each($.proxy(this.attachPagerLinkAjax, this));
- };
- /**
- * Attach the ajax behavior to a singe link.
- *
- * @param {string} [id]
- * The ID of the link.
- * @param {HTMLElement} link
- * The link element.
- */
- Drupal.views.ajaxView.prototype.attachPagerLinkAjax = function(id, link) {
- const $link = $(link);
- const viewData = {};
- const href = $link.attr('href');
- // Construct an object using the settings defaults and then overriding
- // with data specific to the link.
- $.extend(
- viewData,
- this.settings,
- Drupal.Views.parseQueryString(href),
- // Extract argument data from the URL.
- Drupal.Views.parseViewArgs(href, this.settings.view_base_path),
- );
- const selfSettings = $.extend({}, this.element_settings, {
- submit: viewData,
- base: false,
- element: link,
- });
- this.pagerAjax = Drupal.ajax(selfSettings);
- };
- /**
- * Views scroll to top ajax command.
- *
- * @param {Drupal.Ajax} [ajax]
- * A {@link Drupal.ajax} object.
- * @param {object} response
- * Ajax response.
- * @param {string} response.selector
- * Selector to use.
- */
- Drupal.AjaxCommands.prototype.viewsScrollTop = function(ajax, response) {
- // Scroll to the top of the view. This will allow users
- // to browse newly loaded content after e.g. clicking a pager
- // link.
- const offset = $(response.selector).offset();
- // We can't guarantee that the scrollable object should be
- // the body, as the view could be embedded in something
- // more complex such as a modal popup. Recurse up the DOM
- // and scroll the first element that has a non-zero top.
- let scrollTarget = response.selector;
- while ($(scrollTarget).scrollTop() === 0 && $(scrollTarget).parent()) {
- scrollTarget = $(scrollTarget).parent();
- }
- // Only scroll upward.
- if (offset.top - 10 < $(scrollTarget).scrollTop()) {
- $(scrollTarget).animate({ scrollTop: offset.top - 10 }, 500);
- }
- };
- })(jQuery, Drupal, drupalSettings);
|