diff --git a/src/pat/contentbrowser/src/ContentBrowser.svelte b/src/pat/contentbrowser/src/ContentBrowser.svelte index 2fbaa8ed17..40aa5a60c0 100644 --- a/src/pat/contentbrowser/src/ContentBrowser.svelte +++ b/src/pat/contentbrowser/src/ContentBrowser.svelte @@ -4,7 +4,7 @@ import * as animateScroll from "svelte-scrollto"; import { fly } from "svelte/transition"; import _t from "../../../core/i18n-wrapper"; - import Upload from "../../upload/upload"; + import Upload from "../../upload/upload--implementation"; import contentStore from "./ContentStore"; import { clickOutside, diff --git a/src/pat/controlpanels/contentrule-elements--implementation.js b/src/pat/controlpanels/contentrule-elements--implementation.js index 8a9ad6fa65..a1d7719b24 100644 --- a/src/pat/controlpanels/contentrule-elements--implementation.js +++ b/src/pat/controlpanels/contentrule-elements--implementation.js @@ -1,5 +1,5 @@ import $ from "jquery"; -import Modal from "../modal/modal"; +import Modal from "../modal/modal--implementation"; export default class Contentrules { constructor(el) { diff --git a/src/pat/controlpanels/dexterity-types-listing--implementation.js b/src/pat/controlpanels/dexterity-types-listing--implementation.js index 5e5171221f..73a8f759bc 100644 --- a/src/pat/controlpanels/dexterity-types-listing--implementation.js +++ b/src/pat/controlpanels/dexterity-types-listing--implementation.js @@ -1,5 +1,5 @@ import $ from "jquery"; -import Modal from "../modal/modal"; +import Modal from "../modal/modal--implementation"; export default class DexterityTypesListing { constructor(el) { diff --git a/src/pat/controlpanels/registry--implementation.js b/src/pat/controlpanels/registry--implementation.js index de96b68ad4..8d8d203196 100644 --- a/src/pat/controlpanels/registry--implementation.js +++ b/src/pat/controlpanels/registry--implementation.js @@ -1,6 +1,6 @@ import $ from "jquery"; import utils from "../../core/utils"; -import Modal from "../modal/modal"; +import Modal from "../modal/modal--implementation"; export default class ConfigRegistry { constructor(el) { diff --git a/src/pat/manageportlets/manageportlets.js b/src/pat/manageportlets/manageportlets.js index d15d360706..52a7fa0c25 100644 --- a/src/pat/manageportlets/manageportlets.js +++ b/src/pat/manageportlets/manageportlets.js @@ -1,5 +1,4 @@ import $ from "jquery"; -import Modal from "../modal/modal"; import Base from "@patternslib/patternslib/src/core/base"; import logger from "@patternslib/patternslib/src/core/logging"; import utils from "../../core/utils"; @@ -109,8 +108,11 @@ export default Base.extend({ $message.fadeTo(500, 0.6); }, 3000); }, - showEditPortlet: function (url) { + showEditPortlet: async function (url) { log.info("show edit portlet in modal"); + // manageportlets is registered eagerly, so it loads the modal + // implementation on demand to keep it out of the eager bundle. + const Modal = (await import("../modal/modal--implementation")).default; var that = this; var $a = $(""); $("body").append($a); diff --git a/src/pat/modal/modal--implementation.js b/src/pat/modal/modal--implementation.js new file mode 100644 index 0000000000..b9d2dcb4d3 --- /dev/null +++ b/src/pat/modal/modal--implementation.js @@ -0,0 +1,1042 @@ +import $ from "jquery"; +import Base from "@patternslib/patternslib/src/core/base"; +import _ from "underscore"; +import Backdrop from "../backdrop/backdrop"; +import registry from "@patternslib/patternslib/src/core/registry"; +import dom from "@patternslib/patternslib/src/core/dom"; +import utils from "../../core/utils"; +import _t from "../../core/i18n-wrapper"; + +// jquery-form ($.fn.ajaxSubmit) is loaded lazily at its single call site in +// handleFormAction — most modals never AJAX-submit a form, so it stays out of +// this module's static import graph. + +export default Base.extend({ + name: "plone-modal", + trigger: ".pat-plone-modal", + parser: "mockup", + createModal: null, + $model: null, + defaults: { + width: "", + height: "", + modalSizeClass: "", + margin: 0, + position: "center middle", // format: ' ' -- allowed values: top, bottom, left, right, center, middle + triggers: [], + zIndexSelector: ".modal-wrapper,.modal-backdrop", + backdrop: "body", // Element to initiate the Backdrop on. + backdropOptions: { + zIndex: "1040", + opacity: "0.85", + className: "modal-backdrop", + classActiveName: "backdrop-active", + closeOnEsc: true, + closeOnClick: true, + }, + title: null, + titleSelector: "h1:first", + buttons: '.formControls > input[type="submit"], .formControls > button', + content: "#content", + automaticallyAddButtonActions: true, + loadLinksWithinModal: true, + prependContent: ".portalMessage", + onRender: null, + templateOptions: { + className: "modal fade", + classDialog: "modal-dialog", + classModal: "modal-content", + classHeaderName: "modal-header", + classBodyName: "modal-body", + classFooterName: "modal-footer", + classWrapperName: "modal-wrapper", + classWrapperInnerName: "modal-wrapper-inner", + classActiveName: "show", + classPrependName: "", // String, css class to be applied to the wrapper of the prepended content + classContentName: "", // String, class name to be applied to the content of the modal, useful for modal specific styling + template: + "" + + '
' + + ' " + + "
", + }, + actions: {}, + actionOptions: { + eventType: "click", + disableAjaxFormSubmit: false, + target: null, + ajaxUrl: null, // string, or function($el, options) that returns a string + modalFunction: null, // String, function name on self to call + isForm: false, + timeout: 5000, + displayInModal: true, + reloadWindowOnClose: true, + error: ".portalMessage.error, .alert-danger", + formFieldError: ".field.error", + onSuccess: null, + onError: null, + onFormError: null, + onTimeout: null, + redirectOnResponse: false, + redirectToUrl: function ($action, response) { + var reg; + reg = / 1) { + // view url as data attribute on body (Plone 5) + return reg[1].split('"')[0]; + } + reg = / 1) { + // Base url as data attribute on body (Plone 5) + return reg[1].split('"')[0]; + } + reg = / 1) { + // base tag available (Plone 4) + return reg[1]; + } + return ""; + }, + }, + form: function (actions) { + var self = this; + var $modal = self.$modal; + + if (self.options.automaticallyAddButtonActions) { + actions[self.options.buttons] = {}; + } + actions.a = {}; + + $.each(actions, function (action, options) { + var actionKeys = _.union(_.keys(self.options.actionOptions), [ + "templateOptions", + ]); + var actionOptions = $.extend( + true, + {}, + self.options.actionOptions, + _.pick(options, actionKeys) + ); + options.templateOptions = $.extend( + true, + options.templateOptions, + self.options.templateOptions + ); + + var patternKeys = _.union(_.keys(self.options.actionOptions), [ + "actions", + "actionOptions", + ]); + var patternOptions = $.extend( + true, + _.omit(options, patternKeys), + self.options + ); + $(action, $("." + options.templateOptions.classBodyName, $modal)).each( + function () { + var $action = $(this); + $action.on(actionOptions.eventType, function (e) { + e.stopPropagation(); + e.preventDefault(); + + self.loading.show(false); + + // handle event on $action using a function on self + if (actionOptions.modalFunction !== null) { + self[actionOptions.modalFunction](); + // handle event on input/button using jquery.form library + } else if ( + $.nodeName($action[0], "input") || + $.nodeName($action[0], "button") || + options.isForm === true + ) { + self.options.handleFormAction.apply(self, [ + $action, + actionOptions, + patternOptions, + ]); + // handle event on link with jQuery.ajax + } else if ( + options.ajaxUrl !== null || + $.nodeName($action[0], "a") + ) { + self.options.handleLinkAction.apply(self, [ + $action, + actionOptions, + patternOptions, + ]); + } + }); + } + ); + }); + }, + handleFormAction: async function ($action, options, patternOptions) { + var self = this; + + // pass action that was clicked when submiting form + var extraData = {}; + extraData[$action.attr("name")] = $action.attr("value"); + + var $form; + + if ($.nodeName($action[0], "form")) { + $form = $action; + } else { + $form = $action.parents("form:not(.disableAutoSubmit)"); + } + + var url; + if (options.ajaxUrl !== null) { + if (typeof options.ajaxUrl === "function") { + url = options.ajaxUrl.apply(self, [$action, options]); + } else { + url = options.ajaxUrl; + } + } else { + url = $action.parents("form").attr("action"); + } + + if (options.disableAjaxFormSubmit) { + if ($action.attr("name") && $action.attr("value")) { + $form.append( + $( + '' + ) + ); + } + $form.trigger("submit"); + return; + } + // We want to trigger the form submit event but NOT use the default + $form.on("submit", function (e) { + e.preventDefault(); + }); + $form.trigger("submit"); + + self.loading.show(false); + // Load the jquery-form plugin ($.fn.ajaxSubmit) on demand — this is + // its only use in mockup, so it need not weigh on every page. + await import("jquery-form"); + $form.ajaxSubmit({ + timeout: options.timeout, + data: extraData, + url: url, + error: function (xhr, textStatus, errorStatus) { + self.loading.hide(); + if (textStatus === "timeout" && options.onTimeout) { + options.onTimeout.apply(self, xhr, errorStatus); + // on "error", "abort", and "parsererror" + } else if (options.onError) { + if (typeof options.onError === "string") { + window[options.onError](xhr, textStatus, errorStatus); + } else { + options.onError(xhr, textStatus, errorStatus); + } + } else { + // window.alert(_t('There was an error submitting the form.')); + console.log("error happened", textStatus, " do something"); + } + self.emit("formActionError", [xhr, textStatus, errorStatus]); + }, + success: function (response, state, xhr, form) { + self.loading.hide(); + // if error is found (NOTE: check for both the portal errors + // and the form field-level errors) + if ( + $(options.error, response).length !== 0 || + $(options.formFieldError, response).length !== 0 + ) { + if (options.onFormError) { + if (typeof options.onFormError === "string") { + window[options.onFormError]( + self, + response, + state, + xhr, + form + ); + } else { + options.onFormError(self, response, state, xhr, form); + } + } else { + self.redraw(response, patternOptions); + } + return; + } + + if (options.redirectOnResponse === true) { + if (typeof options.redirectToUrl === "function") { + window.parent.location.href = options.redirectToUrl.apply( + self, + [$action, response, options] + ); + } else { + window.parent.location.href = options.redirectToUrl; + } + return; // cut out right here since we're changing url + } + + if (options.onSuccess) { + if (typeof options.onSuccess === "string") { + window[options.onSuccess](self, response, state, xhr, form); + } else { + options.onSuccess(self, response, state, xhr, form); + } + } + + if (options.displayInModal === true) { + self.redraw(response, patternOptions); + } else { + $action.trigger("destroy.plone-modal.patterns"); + // also calls hide + if (options.reloadWindowOnClose) { + self.reloadWindow(); + } + } + self.emit("formActionSuccess", [response, state, xhr, form]); + }, + }); + }, + handleLinkAction: function ($action, options, patternOptions) { + var self = this; + var url; + if ($action.hasClass("pat-plone-modal")) { + // if link is a modal pattern, do not reload the page + return; + } + + // Figure out URL + if (options.ajaxUrl) { + if (typeof options.ajaxUrl === "function") { + url = options.ajaxUrl.apply(self, [$action, options]); + } else { + url = options.ajaxUrl; + } + } else { + url = $action.attr("href"); + } + + // Non-ajax link (I know it says "ajaxUrl" ...) + if (options.displayInModal === false) { + if ($action.attr("target") === "_blank") { + window.open(url, "_blank"); + self.loading.hide(); + } else { + window.location = url; + } + return; + } + + // ajax version + $.ajax({ + url: url, + }) + .fail(function (xhr, textStatus, errorStatus) { + if (textStatus === "timeout" && options.onTimeout) { + options.onTimeout(self.$modal, xhr, errorStatus); + + // on "error", "abort", and "parsererror" + } else if (options.onError) { + options.onError(xhr, textStatus, errorStatus); + } else { + window.alert(_t("There was an error loading modal.")); + } + self.emit("linkActionError", [xhr, textStatus, errorStatus]); + }) + .done(function (response, state, xhr) { + self.redraw(response, patternOptions); + if (options.onSuccess) { + if (typeof options.onSuccess === "string") { + window[options.onSuccess](self, response, state, xhr); + } else { + options.onSuccess(self, response, state, xhr); + } + } + + self.emit("linkActionSuccess", [response, state, xhr]); + }) + .always(function () { + self.loading.hide(); + }); + }, + render: function (options) { + var self = this; + + self.emit("before-render"); + + if (!self.$raw) { + return; + } + var $raw = self.$raw.clone(); + + // Object that will be passed to the template + var tplObject = { + title: "", + prepend: "
", + content: "", + modalSizeClass: options.modalSizeClass, + buttons: '
', + options: options.templateOptions, + closeButtonLabel: _t("Close"), + }; + + // setup the Title + if (options.title === null) { + var $title = $(options.titleSelector, $raw); + tplObject.title = $title.html(); + $(options.titleSelector, $raw).remove(); + } else { + tplObject.title = options.title; + } + + // Grab items to to insert into the prepend area + if (options.prependContent) { + tplObject.prepend = $("
") + .append($(options.prependContent, $raw).clone()) + .html(); + $(options.prependContent, $raw).remove(); + } + + // Filter out the content if there is a selector provided + if (options.content) { + tplObject.content = $(options.content, $raw).html(); + } else { + tplObject.content = $raw.html(); + } + + // Render html + self.$modal = $( + _.template(self.options.templateOptions.template)(tplObject) + ); + self.$modalDialog = $( + "> ." + self.options.templateOptions.classDialog, + self.$modal + ); + self.$modalContent = $( + "> ." + self.options.templateOptions.classModal, + self.$modalDialog + ); + + // In most browsers, when you hit the enter key while a form element is focused + // the browser will trigger the form 'submit' event. Google Chrome also does this, + // but not when when the default submit button is hidden with 'display: none'. + // The following code will work around this issue: + $("form", self.$modal).on("keydown", function (event) { + // ignore keys which are not enter, and ignore enter inside a textarea. + if (event.key !== "Enter" || event.target.nodeName === "TEXTAREA") { + return; + } + event.preventDefault(); + $("input[type=submit], button[type=submit], button:not(type)", this) + .eq(0) + .trigger("click"); + }); + + // Setup buttons + $(options.buttons, self.$modal).each(function () { + var $button = $(this); + $button + .on("click", function (e) { + e.stopPropagation(); + e.preventDefault(); + }) + .clone() + .appendTo($(".pattern-modal-buttons", self.$modal)) + .off("click") + .on("click", function (e) { + e.stopPropagation(); + e.preventDefault(); + $button.trigger("click"); + }); + $button.hide(); + }); + + self.emit("before-events-setup"); + + // Wire up events + self.$modal[0] + .querySelectorAll( + `.modal-header > .modal-close, + .modal-footer > .pattern-modal-buttons > .modal-close, + .modal-footer [name="form.buttons.Cancel" i]` + ) + .forEach((el) => { + $(el) + .off("click") + .on("click", (e) => { + e.stopPropagation(); + e.preventDefault(); + $(e.target).trigger("destroy.plone-modal.patterns"); + }); + }); + + // form + if (options.form) { + options.form.apply(self, [options.actions]); + } + + self.$modal + .addClass(self.options.templateOptions.className) + .on("destroy.plone-modal.patterns", function (e) { + e.stopPropagation(); + self.hide(); + }) + .on("resize.plone-modal.patterns", function (e) { + e.stopPropagation(); + e.preventDefault(); + self.positionModal(); + }) + .appendTo(self.$wrapperInner); + + if (self.options.loadLinksWithinModal) { + self.$modal.on("click", function (e) { + e.stopPropagation(); + if ($.nodeName(e.target, "a")) { + e.preventDefault(); + // TODO: open links inside modal + // and slide modal body + } + self.$modal.trigger("modal-click"); + }); + } + self.$modal.data("pattern-" + self.name, self); + self.emit("after-render"); + if (options.onRender) { + if (typeof options.onRender === "string") { + window[options.onRender](self); + } else { + options.onRender(self); + } + } + }, + }, + reloadWindow: function () { + window.parent.location.reload(); + }, + init: function () { + import("./modal.scss"); + + var self = this; + self.options.loadLinksWithinModal = $.parseJSON( + self.options.loadLinksWithinModal + ); + + if (self.options.backdropOptions.closeOnEsc === true) { + $(document).on("keydown", function (e) { + if (self.$el.is("." + self.options.templateOptions.classActiveName)) { + if (e.key === "Esc") { + // ESC key pressed + self.hide(); + } + } + }); + } + + $(window.parent).resize(function () { + self.positionModal(); + }); + + if (self.options.triggers) { + $.each(self.options.triggers, function (i, item) { + var e = item.substring(0, item.indexOf(" ")); + var selector = item.substring(item.indexOf(" "), item.length); + $(selector || self.$el).on(e, function (e) { + e.stopPropagation(); + e.preventDefault(); + self.show(); + }); + }); + } + + if (self.$el.is("a")) { + if (self.$el.attr("href") && !self.options.image) { + if ( + !self.options.target && + self.$el.attr("href").substr(0, 1) === "#" && + self.$el.attr("href").length > 1 + ) { + self.options.target = self.$el.attr("href"); + self.options.content = ""; + } + if ( + !self.options.ajaxUrl && + self.$el.attr("href").substr(0, 1) !== "#" + ) { + self.options.ajaxUrl = function () { + // Resolve ``href`` attribute later, when modal is shown. + return self.$el.attr("href"); + }; + } + } + self.$el.on("click", function (e) { + e.stopPropagation(); + e.preventDefault(); + self.show(); + }); + } + self.initModal(); + }, + + createAjaxModal: function () { + var self = this; + self.emit("before-ajax"); + self.loading.show(); + + var ajaxUrl = self.options.ajaxUrl; + if (typeof ajaxUrl === "function") { + ajaxUrl = ajaxUrl.apply(self, [self.options]); + } + + self.ajaxXHR = $.ajax({ + url: ajaxUrl, + type: self.options.ajaxType, + }) + .done(function (response, textStatus, xhr) { + self.ajaxXHR = undefined; + self.$raw = $("
").append($(utils.parseBodyTag(response))); + self.emit("after-ajax", self, textStatus, xhr); + self._show(); + }) + .fail(function (xhr, textStatus, errorStatus) { + var options = self.options.actionOptions; + if (textStatus === "timeout" && options.onTimeout) { + options.onTimeout(self.$modal, xhr, errorStatus); + } else if (options.onError) { + options.onError(xhr, textStatus, errorStatus); + } else { + window.alert(_t("There was an error loading modal.")); + self.hide(); + } + self.emit("linkActionError", [xhr, textStatus, errorStatus]); + }) + .always(function () { + self.loading.hide(); + }); + }, + + createTargetModal: function () { + var self = this; + self.$raw = $(self.options.target).clone(); + self._show(); + }, + + createBasicModal: function () { + var self = this; + self.$raw = $("
").html(self.$el.clone()); + self._show(); + }, + + createHtmlModal: function () { + var self = this; + var $el = $(self.options.html); + self.$raw = $el; + self._show(); + }, + + createImageModal: function () { + var self = this; + self.$wrapper.addClass("image-modal"); + var src = self.$el.attr("href"); + var srcset = self.$el.attr("data-modal-srcset") || ""; + var title = $.trim(self.$el.text()) || "Image"; + // XXX aria? + self.$raw = $( + "

" + + title + + '

' + ); + self._show(); + }, + + initModal: function () { + var self = this; + if (self.options.ajaxUrl) { + self.createModal = self.createAjaxModal; + } else if (self.options.target) { + self.createModal = self.createTargetModal; + } else if (self.options.html) { + self.createModal = self.createHtmlModal; + } else if (self.options.image) { + self.createModal = self.createImageModal; + } else { + self.createModal = self.createBasicModal; + } + }, + + findPosition: function ( + horpos, + vertpos, + margin, + modalWidth, + modalHeight, + wrapperInnerWidth, + wrapperInnerHeight + ) { + var returnpos = {}; + var absTop, absBottom, absLeft, absRight; + + // -- HORIZONTAL POSITION ----------------------------------------------- + if (horpos === "left") { + absLeft = margin + "px"; + // if the width of the wrapper is smaller than the modal, and thus the + // screen is smaller than the modal, force the left to simply be 0 + if (modalWidth > wrapperInnerWidth) { + absLeft = "0px"; + } + returnpos.left = absLeft; + } else if (horpos === "right") { + absRight = margin + "px"; + // if the width of the wrapper is smaller than the modal, and thus the + // screen is smaller than the modal, force the right to simply be 0 + if (modalWidth > wrapperInnerWidth) { + absRight = "0px"; + } + returnpos.right = absRight; + returnpos.left = "auto"; + } + // default, no specified location, is to center + else { + absLeft = wrapperInnerWidth / 2 - modalWidth / 2 - margin + "px"; + // if the width of the wrapper is smaller than the modal, and thus the + // screen is smaller than the modal, force the left to simply be 0 + if (modalWidth > wrapperInnerWidth) { + absLeft = "0px"; + } + returnpos.left = absLeft; + } + + // -- VERTICAL POSITION ------------------------------------------------- + if (vertpos === "top") { + absTop = margin + "px"; + // if the height of the wrapper is smaller than the modal, and thus the + // screen is smaller than the modal, force the top to simply be 0 + if (modalHeight > wrapperInnerHeight) { + absTop = "0px"; + } + returnpos.top = absTop; + } else if (vertpos === "bottom") { + absBottom = margin + "px"; + // if the height of the wrapper is smaller than the modal, and thus the + // screen is smaller than the modal, force the bottom to simply be 0 + if (modalHeight > wrapperInnerHeight) { + absBottom = "0px"; + } + returnpos.bottom = absBottom; + returnpos.top = "auto"; + } else { + // default case, no specified location, is to center + absTop = wrapperInnerHeight / 2 - modalHeight / 2 - margin + "px"; + // if the height of the wrapper is smaller than the modal, and thus the + // screen is smaller than the modal, force the top to simply be 0 + if (modalHeight > wrapperInnerHeight) { + absTop = "0px"; + } + returnpos.top = absTop; + } + return returnpos; + }, + + modalInitialized: function () { + var self = this; + return self.$modal !== null && self.$modal !== undefined; + }, + + activateFocusTrap: function () { + var self = this; + const modal_el = self.$modal[0]; + const focusable_selector = `select, input:not([type="hidden"]), textarea, button, a`; + + // Re-query visible focusable elements on each Tab press so that + // dynamically loaded content (e.g. AJAX-loaded occurrence lists) + // is always reachable via keyboard. + function getVisibleInputs() { + var bodyEl = modal_el.querySelector( + `.${self.options.templateOptions.classBodyName}` + ); + var footerEl = modal_el.querySelector( + `.${self.options.templateOptions.classFooterName}` + ); + var inputsBody = bodyEl + ? bodyEl.querySelectorAll(focusable_selector) + : []; + var inputsFooter = footerEl + ? footerEl.querySelectorAll(focusable_selector) + : []; + var inputs = []; + for (const el of [...inputsBody, ...inputsFooter]) { + if (dom.is_visible(el)) { + inputs.push(el); + } + } + if (inputs.length === 0) { + inputs = [...modal_el.querySelectorAll(".modal-title")]; + } + return inputs; + } + + var closeInput = modal_el.querySelector(".modal-close"); + + // Remove previous focus trap listener to prevent duplicates + // when activateFocusTrap is called multiple times (e.g. redraw). + if (self._focusTrapHandler) { + modal_el.removeEventListener("keydown", self._focusTrapHandler); + } + self._focusTrapHandler = (e) => { + if (e.key === "Tab") { + e.preventDefault(); + + var inputs = getVisibleInputs(); + var firstInput = inputs.length !== 0 ? inputs[0] : null; + var lastInput = inputs.length !== 0 ? inputs[inputs.length - 1] : null; + var target = e.target; + var currentIndex = inputs.indexOf(target); + if (currentIndex >= 0 && currentIndex < inputs.length) { + var nextIndex = currentIndex + (e.shiftKey ? -1 : 1); + if (nextIndex < 0 || nextIndex >= inputs.length) { + closeInput.focus(); + } else { + inputs[nextIndex].focus(); + } + } else if (e.shiftKey && lastInput) { + lastInput.focus(); + } else if (firstInput) { + firstInput.focus(); + } + } + }; + modal_el.addEventListener("keydown", self._focusTrapHandler); + + if (self.options.backdropOptions.closeOnClick === true) { + modal_el.addEventListener("click", (e) => { + if (!e.target.closest(`.${self.options.templateOptions.classModal}`)) { + self.hide(); + } + }); + } + + var inputs = getVisibleInputs(); + var firstInput = inputs.length !== 0 ? inputs[0] : null; + if (firstInput && ["INPUT", "SELECT", "TEXTAREA"].includes(firstInput.nodeName)) { + // autofocus first element when opening a modal with a form + firstInput.focus(); + } + }, + + positionModal: function () { + /* re-position modal at any point. + * + * Uses: + * options.margin + * options.width + * options.height + * options.position + */ + var self = this; + // modal isn't initialized + if (!self.modalInitialized()) { + return; + } + // clear out any previously set styling + self.$modal.removeAttr("style"); + + // if backdrop wrapper is set on body, then wrapper should have height of + // the window, so we can do scrolling of inner wrapper + if (self.$wrapper.parent().is("body")) { + self.$wrapper.height($(window.parent).height()); + } + + var margin = + typeof self.options.margin === "function" + ? self.options.margin() + : self.options.margin; + let modalCss = { + position: "absolute", + }; + if (margin !== "0") { + modalCss["padding"] = margin; + } + self.$modal.css(modalCss); + self.$modalDialog.css({ + // margin: "0", + // padding: "0", + width: self.options.width, // defaults to "", which doesn't override other css + height: self.options.height, // defaults to "", which doesn't override other css + }); + self.$modalContent.css({ + width: self.options.width, // defaults to "", which doesn't override other css + }); + + var posopt = self.options.position.split(" "), + horpos = posopt[0], + vertpos = posopt[1]; + var modalWidth = self.$modalDialog.outerWidth(true); + var modalHeight = self.$modalDialog.outerHeight(true); + var wrapperInnerWidth = self.$wrapperInner.width(); + var wrapperInnerHeight = self.$wrapperInner.height(); + var pos = self.findPosition( + horpos, + vertpos, + margin, + modalWidth, + modalHeight, + wrapperInnerWidth, + wrapperInnerHeight + ); + for (var key in pos) { + self.$modalDialog.css(key, pos[key]); + } + }, + + render: function (options) { + var self = this; + self.emit("render"); + self.options.render.apply(self, [options]); + self.emit("rendered"); + }, + + show: function () { + var self = this; + self.backdrop = self.createBackdrop(); + self.createModal(); + }, + + createBackdrop: function () { + var self = this, + backdrop = new Backdrop( + self.$el.parents(self.options.backdrop), + self.options.backdropOptions + ), + zIndex = self.options.backdropOptions.zIndex || 1041; + + $(self.options.zIndexSelector).each(function () { + zIndex = Math.max(zIndex, parseInt($(this).css("zIndex")) + 1 || 1041); + }); + + self.$wrapper = $("
") + .hide() + .css({ + "z-index": zIndex, + "overflow-y": "auto", + "position": "fixed", + "height": "100%", + "width": "100%", + "bottom": "0", + "left": "0", + "right": "0", + "top": "0", + }) + .addClass(self.options.templateOptions.classWrapperName) + .insertBefore(backdrop.$backdrop) + .on("click", function (e) { + if (self.options.backdropOptions.closeOnClick) { + e.stopPropagation(); + e.preventDefault(); + backdrop.hide(); + } + }); + backdrop.on("hidden", function () { + if ( + self.$modal !== undefined && + self.$modal.hasClass(self.options.templateOptions.classActiveName) + ) { + self.hide(); + } + }); + self.loading = new utils.Loading({ + backdrop: backdrop, + }); + self.$wrapperInner = $("
") + .addClass(self.options.classWrapperInnerName) + .css({ + position: "absolute", + bottom: "0", + left: "0", + right: "0", + top: "0", + }) + .appendTo(self.$wrapper); + return backdrop; + }, + + _show: function () { + var self = this; + self.render.apply(self, [self.options]); + self.emit("show"); + self.backdrop.show(); + self.$wrapper.show(); + self.loading.hide(); + self.$el.addClass(self.options.templateOptions.classActiveName); + self.$modal.addClass(self.options.templateOptions.classActiveName); + registry.scan(self.$modal); + self.positionModal(); + $(window.parent).on("resize.plone-modal.patterns", function () { + self.positionModal(); + }); + $("body").addClass("modal-open"); + self.emit("shown"); + self.activateFocusTrap(); + }, + hide: function () { + var self = this; + if (self.ajaxXHR) { + self.ajaxXHR.abort(); + } + self.emit("hide"); + if (self._suppressHide) { + if (!window.confirm(self._suppressHide)) { + return; + } + } + self.loading.hide(); + self.$el.removeClass(self.options.templateOptions.classActiveName); + if (self.$modal !== undefined) { + self.$modal.remove(); + self.initModal(); + } + self.$wrapper.remove(); + if ($(".modal", $("body")).length < 1) { + self._suppressHide = undefined; + self.backdrop.hide(); + $("body").removeClass("modal-open"); + $(window.parent).off("resize.plone-modal.patterns"); + } + self.emit("hidden"); + self.$el.focus(); + }, + + redraw: function (response, options) { + var self = this; + self.emit("beforeDraw"); + self.$modal.remove(); + self.$raw = $("
").append($(utils.parseBodyTag(response))); + self.render.apply(self, [options || self.options]); + self.$modal.addClass(self.options.templateOptions.classActiveName); + self.positionModal(); + registry.scan(self.$modal); + self.emit("afterDraw"); + self.activateFocusTrap(); + }, +}); diff --git a/src/pat/modal/modal--implementation.test.js b/src/pat/modal/modal--implementation.test.js new file mode 100644 index 0000000000..792c6d84bd --- /dev/null +++ b/src/pat/modal/modal--implementation.test.js @@ -0,0 +1,23 @@ +import $ from "jquery"; +import Modal from "./modal--implementation"; + +// The tinymce link modal (pat-tinymce js/links.js) constructs the modal +// imperatively (`new Modal(...)`) and calls show() synchronously right after. +// The implementation must therefore be a constructable pattern that exposes +// its methods synchronously — not a config object grafted asynchronously by +// the thin modal.js registration module. +describe("modal implementation", function () { + let $el; + beforeEach(function () { + $el = $("
").appendTo("body"); + }); + afterEach(function () { + $el.remove(); + }); + + it("is constructable and exposes its methods synchronously", function () { + const modal = new Modal($el, { html: "
content
" }); + expect(typeof modal.show).toBe("function"); + expect(typeof modal.hide).toBe("function"); + }); +}); diff --git a/src/pat/modal/modal.js b/src/pat/modal/modal.js index 8b14b1c80a..a2d7865ff6 100644 --- a/src/pat/modal/modal.js +++ b/src/pat/modal/modal.js @@ -1,1037 +1,27 @@ import $ from "jquery"; import Base from "@patternslib/patternslib/src/core/base"; -import _ from "underscore"; -import Backdrop from "../backdrop/backdrop"; -import registry from "@patternslib/patternslib/src/core/registry"; -import dom from "@patternslib/patternslib/src/core/dom"; -import utils from "../../core/utils"; -import _t from "../../core/i18n-wrapper"; - -import "jquery-form"; +// Thin registration module: the ~1000-line modal implementation (incl. the +// Backdrop wiring, templating and the lazy jquery-form dependency) is loaded +// on first match, so it stays out of the eager patterns chunk on pages +// without a modal. Imperative callers that need the class directly import +// ./modal--implementation instead. export default Base.extend({ name: "plone-modal", trigger: ".pat-plone-modal", parser: "mockup", - createModal: null, - $model: null, - defaults: { - width: "", - height: "", - modalSizeClass: "", - margin: 0, - position: "center middle", // format: ' ' -- allowed values: top, bottom, left, right, center, middle - triggers: [], - zIndexSelector: ".modal-wrapper,.modal-backdrop", - backdrop: "body", // Element to initiate the Backdrop on. - backdropOptions: { - zIndex: "1040", - opacity: "0.85", - className: "modal-backdrop", - classActiveName: "backdrop-active", - closeOnEsc: true, - closeOnClick: true, - }, - title: null, - titleSelector: "h1:first", - buttons: '.formControls > input[type="submit"], .formControls > button', - content: "#content", - automaticallyAddButtonActions: true, - loadLinksWithinModal: true, - prependContent: ".portalMessage", - onRender: null, - templateOptions: { - className: "modal fade", - classDialog: "modal-dialog", - classModal: "modal-content", - classHeaderName: "modal-header", - classBodyName: "modal-body", - classFooterName: "modal-footer", - classWrapperName: "modal-wrapper", - classWrapperInnerName: "modal-wrapper-inner", - classActiveName: "show", - classPrependName: "", // String, css class to be applied to the wrapper of the prepended content - classContentName: "", // String, class name to be applied to the content of the modal, useful for modal specific styling - template: - "" + - '
' + - ' " + - "
", - }, - actions: {}, - actionOptions: { - eventType: "click", - disableAjaxFormSubmit: false, - target: null, - ajaxUrl: null, // string, or function($el, options) that returns a string - modalFunction: null, // String, function name on self to call - isForm: false, - timeout: 5000, - displayInModal: true, - reloadWindowOnClose: true, - error: ".portalMessage.error, .alert-danger", - formFieldError: ".field.error", - onSuccess: null, - onError: null, - onFormError: null, - onTimeout: null, - redirectOnResponse: false, - redirectToUrl: function ($action, response) { - var reg; - reg = / 1) { - // view url as data attribute on body (Plone 5) - return reg[1].split('"')[0]; - } - reg = / 1) { - // Base url as data attribute on body (Plone 5) - return reg[1].split('"')[0]; - } - reg = / 1) { - // base tag available (Plone 4) - return reg[1]; - } - return ""; - }, - }, - form: function (actions) { - var self = this; - var $modal = self.$modal; - - if (self.options.automaticallyAddButtonActions) { - actions[self.options.buttons] = {}; - } - actions.a = {}; - - $.each(actions, function (action, options) { - var actionKeys = _.union(_.keys(self.options.actionOptions), [ - "templateOptions", - ]); - var actionOptions = $.extend( - true, - {}, - self.options.actionOptions, - _.pick(options, actionKeys) - ); - options.templateOptions = $.extend( - true, - options.templateOptions, - self.options.templateOptions - ); - - var patternKeys = _.union(_.keys(self.options.actionOptions), [ - "actions", - "actionOptions", - ]); - var patternOptions = $.extend( - true, - _.omit(options, patternKeys), - self.options - ); - $(action, $("." + options.templateOptions.classBodyName, $modal)).each( - function () { - var $action = $(this); - $action.on(actionOptions.eventType, function (e) { - e.stopPropagation(); - e.preventDefault(); - - self.loading.show(false); - - // handle event on $action using a function on self - if (actionOptions.modalFunction !== null) { - self[actionOptions.modalFunction](); - // handle event on input/button using jquery.form library - } else if ( - $.nodeName($action[0], "input") || - $.nodeName($action[0], "button") || - options.isForm === true - ) { - self.options.handleFormAction.apply(self, [ - $action, - actionOptions, - patternOptions, - ]); - // handle event on link with jQuery.ajax - } else if ( - options.ajaxUrl !== null || - $.nodeName($action[0], "a") - ) { - self.options.handleLinkAction.apply(self, [ - $action, - actionOptions, - patternOptions, - ]); - } - }); - } - ); - }); - }, - handleFormAction: function ($action, options, patternOptions) { - var self = this; - - // pass action that was clicked when submiting form - var extraData = {}; - extraData[$action.attr("name")] = $action.attr("value"); - - var $form; - - if ($.nodeName($action[0], "form")) { - $form = $action; - } else { - $form = $action.parents("form:not(.disableAutoSubmit)"); - } - - var url; - if (options.ajaxUrl !== null) { - if (typeof options.ajaxUrl === "function") { - url = options.ajaxUrl.apply(self, [$action, options]); - } else { - url = options.ajaxUrl; - } - } else { - url = $action.parents("form").attr("action"); - } - - if (options.disableAjaxFormSubmit) { - if ($action.attr("name") && $action.attr("value")) { - $form.append( - $( - '' - ) - ); - } - $form.trigger("submit"); - return; - } - // We want to trigger the form submit event but NOT use the default - $form.on("submit", function (e) { - e.preventDefault(); - }); - $form.trigger("submit"); - - self.loading.show(false); - $form.ajaxSubmit({ - timeout: options.timeout, - data: extraData, - url: url, - error: function (xhr, textStatus, errorStatus) { - self.loading.hide(); - if (textStatus === "timeout" && options.onTimeout) { - options.onTimeout.apply(self, xhr, errorStatus); - // on "error", "abort", and "parsererror" - } else if (options.onError) { - if (typeof options.onError === "string") { - window[options.onError](xhr, textStatus, errorStatus); - } else { - options.onError(xhr, textStatus, errorStatus); - } - } else { - // window.alert(_t('There was an error submitting the form.')); - console.log("error happened", textStatus, " do something"); - } - self.emit("formActionError", [xhr, textStatus, errorStatus]); - }, - success: function (response, state, xhr, form) { - self.loading.hide(); - // if error is found (NOTE: check for both the portal errors - // and the form field-level errors) - if ( - $(options.error, response).length !== 0 || - $(options.formFieldError, response).length !== 0 - ) { - if (options.onFormError) { - if (typeof options.onFormError === "string") { - window[options.onFormError]( - self, - response, - state, - xhr, - form - ); - } else { - options.onFormError(self, response, state, xhr, form); - } - } else { - self.redraw(response, patternOptions); - } - return; - } - - if (options.redirectOnResponse === true) { - if (typeof options.redirectToUrl === "function") { - window.parent.location.href = options.redirectToUrl.apply( - self, - [$action, response, options] - ); - } else { - window.parent.location.href = options.redirectToUrl; - } - return; // cut out right here since we're changing url - } - - if (options.onSuccess) { - if (typeof options.onSuccess === "string") { - window[options.onSuccess](self, response, state, xhr, form); - } else { - options.onSuccess(self, response, state, xhr, form); - } - } - - if (options.displayInModal === true) { - self.redraw(response, patternOptions); - } else { - $action.trigger("destroy.plone-modal.patterns"); - // also calls hide - if (options.reloadWindowOnClose) { - self.reloadWindow(); - } - } - self.emit("formActionSuccess", [response, state, xhr, form]); - }, - }); - }, - handleLinkAction: function ($action, options, patternOptions) { - var self = this; - var url; - if ($action.hasClass("pat-plone-modal")) { - // if link is a modal pattern, do not reload the page - return; - } - - // Figure out URL - if (options.ajaxUrl) { - if (typeof options.ajaxUrl === "function") { - url = options.ajaxUrl.apply(self, [$action, options]); - } else { - url = options.ajaxUrl; - } - } else { - url = $action.attr("href"); - } - - // Non-ajax link (I know it says "ajaxUrl" ...) - if (options.displayInModal === false) { - if ($action.attr("target") === "_blank") { - window.open(url, "_blank"); - self.loading.hide(); - } else { - window.location = url; - } - return; - } - - // ajax version - $.ajax({ - url: url, - }) - .fail(function (xhr, textStatus, errorStatus) { - if (textStatus === "timeout" && options.onTimeout) { - options.onTimeout(self.$modal, xhr, errorStatus); - - // on "error", "abort", and "parsererror" - } else if (options.onError) { - options.onError(xhr, textStatus, errorStatus); - } else { - window.alert(_t("There was an error loading modal.")); - } - self.emit("linkActionError", [xhr, textStatus, errorStatus]); - }) - .done(function (response, state, xhr) { - self.redraw(response, patternOptions); - if (options.onSuccess) { - if (typeof options.onSuccess === "string") { - window[options.onSuccess](self, response, state, xhr); - } else { - options.onSuccess(self, response, state, xhr); - } - } - - self.emit("linkActionSuccess", [response, state, xhr]); - }) - .always(function () { - self.loading.hide(); - }); - }, - render: function (options) { - var self = this; - - self.emit("before-render"); - - if (!self.$raw) { - return; - } - var $raw = self.$raw.clone(); - - // Object that will be passed to the template - var tplObject = { - title: "", - prepend: "
", - content: "", - modalSizeClass: options.modalSizeClass, - buttons: '
', - options: options.templateOptions, - closeButtonLabel: _t("Close"), - }; - - // setup the Title - if (options.title === null) { - var $title = $(options.titleSelector, $raw); - tplObject.title = $title.html(); - $(options.titleSelector, $raw).remove(); - } else { - tplObject.title = options.title; - } - - // Grab items to to insert into the prepend area - if (options.prependContent) { - tplObject.prepend = $("
") - .append($(options.prependContent, $raw).clone()) - .html(); - $(options.prependContent, $raw).remove(); - } - - // Filter out the content if there is a selector provided - if (options.content) { - tplObject.content = $(options.content, $raw).html(); - } else { - tplObject.content = $raw.html(); - } - - // Render html - self.$modal = $( - _.template(self.options.templateOptions.template)(tplObject) - ); - self.$modalDialog = $( - "> ." + self.options.templateOptions.classDialog, - self.$modal - ); - self.$modalContent = $( - "> ." + self.options.templateOptions.classModal, - self.$modalDialog - ); - - // In most browsers, when you hit the enter key while a form element is focused - // the browser will trigger the form 'submit' event. Google Chrome also does this, - // but not when when the default submit button is hidden with 'display: none'. - // The following code will work around this issue: - $("form", self.$modal).on("keydown", function (event) { - // ignore keys which are not enter, and ignore enter inside a textarea. - if (event.key !== "Enter" || event.target.nodeName === "TEXTAREA") { - return; - } - event.preventDefault(); - $("input[type=submit], button[type=submit], button:not(type)", this) - .eq(0) - .trigger("click"); - }); - - // Setup buttons - $(options.buttons, self.$modal).each(function () { - var $button = $(this); - $button - .on("click", function (e) { - e.stopPropagation(); - e.preventDefault(); - }) - .clone() - .appendTo($(".pattern-modal-buttons", self.$modal)) - .off("click") - .on("click", function (e) { - e.stopPropagation(); - e.preventDefault(); - $button.trigger("click"); - }); - $button.hide(); - }); - - self.emit("before-events-setup"); - - // Wire up events - self.$modal[0] - .querySelectorAll( - `.modal-header > .modal-close, - .modal-footer > .pattern-modal-buttons > .modal-close, - .modal-footer [name="form.buttons.Cancel" i]` - ) - .forEach((el) => { - $(el) - .off("click") - .on("click", (e) => { - e.stopPropagation(); - e.preventDefault(); - $(e.target).trigger("destroy.plone-modal.patterns"); - }); - }); - - // form - if (options.form) { - options.form.apply(self, [options.actions]); - } - - self.$modal - .addClass(self.options.templateOptions.className) - .on("destroy.plone-modal.patterns", function (e) { - e.stopPropagation(); - self.hide(); - }) - .on("resize.plone-modal.patterns", function (e) { - e.stopPropagation(); - e.preventDefault(); - self.positionModal(); - }) - .appendTo(self.$wrapperInner); - - if (self.options.loadLinksWithinModal) { - self.$modal.on("click", function (e) { - e.stopPropagation(); - if ($.nodeName(e.target, "a")) { - e.preventDefault(); - // TODO: open links inside modal - // and slide modal body - } - self.$modal.trigger("modal-click"); - }); - } - self.$modal.data("pattern-" + self.name, self); - self.emit("after-render"); - if (options.onRender) { - if (typeof options.onRender === "string") { - window[options.onRender](self); - } else { - options.onRender(self); - } - } - }, - }, - reloadWindow: function () { - window.parent.location.reload(); - }, - init: function () { - import("./modal.scss"); - - var self = this; - self.options.loadLinksWithinModal = $.parseJSON( - self.options.loadLinksWithinModal - ); - - if (self.options.backdropOptions.closeOnEsc === true) { - $(document).on("keydown", function (e) { - if (self.$el.is("." + self.options.templateOptions.classActiveName)) { - if (e.key === "Esc") { - // ESC key pressed - self.hide(); - } - } - }); - } - - $(window.parent).resize(function () { - self.positionModal(); - }); - - if (self.options.triggers) { - $.each(self.options.triggers, function (i, item) { - var e = item.substring(0, item.indexOf(" ")); - var selector = item.substring(item.indexOf(" "), item.length); - $(selector || self.$el).on(e, function (e) { - e.stopPropagation(); - e.preventDefault(); - self.show(); - }); - }); - } - - if (self.$el.is("a")) { - if (self.$el.attr("href") && !self.options.image) { - if ( - !self.options.target && - self.$el.attr("href").substr(0, 1) === "#" && - self.$el.attr("href").length > 1 - ) { - self.options.target = self.$el.attr("href"); - self.options.content = ""; - } - if ( - !self.options.ajaxUrl && - self.$el.attr("href").substr(0, 1) !== "#" - ) { - self.options.ajaxUrl = function () { - // Resolve ``href`` attribute later, when modal is shown. - return self.$el.attr("href"); - }; - } - } - self.$el.on("click", function (e) { - e.stopPropagation(); - e.preventDefault(); - self.show(); - }); - } - self.initModal(); - }, - - createAjaxModal: function () { - var self = this; - self.emit("before-ajax"); - self.loading.show(); - - var ajaxUrl = self.options.ajaxUrl; - if (typeof ajaxUrl === "function") { - ajaxUrl = ajaxUrl.apply(self, [self.options]); - } - - self.ajaxXHR = $.ajax({ - url: ajaxUrl, - type: self.options.ajaxType, - }) - .done(function (response, textStatus, xhr) { - self.ajaxXHR = undefined; - self.$raw = $("
").append($(utils.parseBodyTag(response))); - self.emit("after-ajax", self, textStatus, xhr); - self._show(); - }) - .fail(function (xhr, textStatus, errorStatus) { - var options = self.options.actionOptions; - if (textStatus === "timeout" && options.onTimeout) { - options.onTimeout(self.$modal, xhr, errorStatus); - } else if (options.onError) { - options.onError(xhr, textStatus, errorStatus); - } else { - window.alert(_t("There was an error loading modal.")); - self.hide(); - } - self.emit("linkActionError", [xhr, textStatus, errorStatus]); - }) - .always(function () { - self.loading.hide(); - }); - }, - - createTargetModal: function () { - var self = this; - self.$raw = $(self.options.target).clone(); - self._show(); - }, - - createBasicModal: function () { - var self = this; - self.$raw = $("
").html(self.$el.clone()); - self._show(); - }, - - createHtmlModal: function () { - var self = this; - var $el = $(self.options.html); - self.$raw = $el; - self._show(); - }, - - createImageModal: function () { - var self = this; - self.$wrapper.addClass("image-modal"); - var src = self.$el.attr("href"); - var srcset = self.$el.attr("data-modal-srcset") || ""; - var title = $.trim(self.$el.text()) || "Image"; - // XXX aria? - self.$raw = $( - "

" + - title + - '

' - ); - self._show(); - }, - - initModal: function () { - var self = this; - if (self.options.ajaxUrl) { - self.createModal = self.createAjaxModal; - } else if (self.options.target) { - self.createModal = self.createTargetModal; - } else if (self.options.html) { - self.createModal = self.createHtmlModal; - } else if (self.options.image) { - self.createModal = self.createImageModal; - } else { - self.createModal = self.createBasicModal; - } - }, - - findPosition: function ( - horpos, - vertpos, - margin, - modalWidth, - modalHeight, - wrapperInnerWidth, - wrapperInnerHeight - ) { - var returnpos = {}; - var absTop, absBottom, absLeft, absRight; - - // -- HORIZONTAL POSITION ----------------------------------------------- - if (horpos === "left") { - absLeft = margin + "px"; - // if the width of the wrapper is smaller than the modal, and thus the - // screen is smaller than the modal, force the left to simply be 0 - if (modalWidth > wrapperInnerWidth) { - absLeft = "0px"; - } - returnpos.left = absLeft; - } else if (horpos === "right") { - absRight = margin + "px"; - // if the width of the wrapper is smaller than the modal, and thus the - // screen is smaller than the modal, force the right to simply be 0 - if (modalWidth > wrapperInnerWidth) { - absRight = "0px"; - } - returnpos.right = absRight; - returnpos.left = "auto"; - } - // default, no specified location, is to center - else { - absLeft = wrapperInnerWidth / 2 - modalWidth / 2 - margin + "px"; - // if the width of the wrapper is smaller than the modal, and thus the - // screen is smaller than the modal, force the left to simply be 0 - if (modalWidth > wrapperInnerWidth) { - absLeft = "0px"; - } - returnpos.left = absLeft; - } - - // -- VERTICAL POSITION ------------------------------------------------- - if (vertpos === "top") { - absTop = margin + "px"; - // if the height of the wrapper is smaller than the modal, and thus the - // screen is smaller than the modal, force the top to simply be 0 - if (modalHeight > wrapperInnerHeight) { - absTop = "0px"; - } - returnpos.top = absTop; - } else if (vertpos === "bottom") { - absBottom = margin + "px"; - // if the height of the wrapper is smaller than the modal, and thus the - // screen is smaller than the modal, force the bottom to simply be 0 - if (modalHeight > wrapperInnerHeight) { - absBottom = "0px"; - } - returnpos.bottom = absBottom; - returnpos.top = "auto"; - } else { - // default case, no specified location, is to center - absTop = wrapperInnerHeight / 2 - modalHeight / 2 - margin + "px"; - // if the height of the wrapper is smaller than the modal, and thus the - // screen is smaller than the modal, force the top to simply be 0 - if (modalHeight > wrapperInnerHeight) { - absTop = "0px"; - } - returnpos.top = absTop; - } - return returnpos; - }, - - modalInitialized: function () { - var self = this; - return self.$modal !== null && self.$modal !== undefined; - }, - - activateFocusTrap: function () { - var self = this; - const modal_el = self.$modal[0]; - const focusable_selector = `select, input:not([type="hidden"]), textarea, button, a`; - - // Re-query visible focusable elements on each Tab press so that - // dynamically loaded content (e.g. AJAX-loaded occurrence lists) - // is always reachable via keyboard. - function getVisibleInputs() { - var bodyEl = modal_el.querySelector( - `.${self.options.templateOptions.classBodyName}` - ); - var footerEl = modal_el.querySelector( - `.${self.options.templateOptions.classFooterName}` - ); - var inputsBody = bodyEl - ? bodyEl.querySelectorAll(focusable_selector) - : []; - var inputsFooter = footerEl - ? footerEl.querySelectorAll(focusable_selector) - : []; - var inputs = []; - for (const el of [...inputsBody, ...inputsFooter]) { - if (dom.is_visible(el)) { - inputs.push(el); - } - } - if (inputs.length === 0) { - inputs = [...modal_el.querySelectorAll(".modal-title")]; - } - return inputs; - } - - var closeInput = modal_el.querySelector(".modal-close"); - - // Remove previous focus trap listener to prevent duplicates - // when activateFocusTrap is called multiple times (e.g. redraw). - if (self._focusTrapHandler) { - modal_el.removeEventListener("keydown", self._focusTrapHandler); - } - self._focusTrapHandler = (e) => { - if (e.key === "Tab") { - e.preventDefault(); - - var inputs = getVisibleInputs(); - var firstInput = inputs.length !== 0 ? inputs[0] : null; - var lastInput = inputs.length !== 0 ? inputs[inputs.length - 1] : null; - var target = e.target; - var currentIndex = inputs.indexOf(target); - if (currentIndex >= 0 && currentIndex < inputs.length) { - var nextIndex = currentIndex + (e.shiftKey ? -1 : 1); - if (nextIndex < 0 || nextIndex >= inputs.length) { - closeInput.focus(); - } else { - inputs[nextIndex].focus(); - } - } else if (e.shiftKey && lastInput) { - lastInput.focus(); - } else if (firstInput) { - firstInput.focus(); - } - } - }; - modal_el.addEventListener("keydown", self._focusTrapHandler); - - if (self.options.backdropOptions.closeOnClick === true) { - modal_el.addEventListener("click", (e) => { - if (!e.target.closest(`.${self.options.templateOptions.classModal}`)) { - self.hide(); - } - }); - } - - var inputs = getVisibleInputs(); - var firstInput = inputs.length !== 0 ? inputs[0] : null; - if (firstInput && ["INPUT", "SELECT", "TEXTAREA"].includes(firstInput.nodeName)) { - // autofocus first element when opening a modal with a form - firstInput.focus(); - } - }, - - positionModal: function () { - /* re-position modal at any point. - * - * Uses: - * options.margin - * options.width - * options.height - * options.position - */ - var self = this; - // modal isn't initialized - if (!self.modalInitialized()) { - return; - } - // clear out any previously set styling - self.$modal.removeAttr("style"); - - // if backdrop wrapper is set on body, then wrapper should have height of - // the window, so we can do scrolling of inner wrapper - if (self.$wrapper.parent().is("body")) { - self.$wrapper.height($(window.parent).height()); - } - - var margin = - typeof self.options.margin === "function" - ? self.options.margin() - : self.options.margin; - let modalCss = { - position: "absolute", - }; - if (margin !== "0") { - modalCss["padding"] = margin; - } - self.$modal.css(modalCss); - self.$modalDialog.css({ - // margin: "0", - // padding: "0", - width: self.options.width, // defaults to "", which doesn't override other css - height: self.options.height, // defaults to "", which doesn't override other css - }); - self.$modalContent.css({ - width: self.options.width, // defaults to "", which doesn't override other css - }); - - var posopt = self.options.position.split(" "), - horpos = posopt[0], - vertpos = posopt[1]; - var modalWidth = self.$modalDialog.outerWidth(true); - var modalHeight = self.$modalDialog.outerHeight(true); - var wrapperInnerWidth = self.$wrapperInner.width(); - var wrapperInnerHeight = self.$wrapperInner.height(); - var pos = self.findPosition( - horpos, - vertpos, - margin, - modalWidth, - modalHeight, - wrapperInnerWidth, - wrapperInnerHeight - ); - for (var key in pos) { - self.$modalDialog.css(key, pos[key]); - } - }, - - render: function (options) { - var self = this; - self.emit("render"); - self.options.render.apply(self, [options]); - self.emit("rendered"); - }, - - show: function () { - var self = this; - self.backdrop = self.createBackdrop(); - self.createModal(); - }, - - createBackdrop: function () { - var self = this, - backdrop = new Backdrop( - self.$el.parents(self.options.backdrop), - self.options.backdropOptions - ), - zIndex = self.options.backdropOptions.zIndex || 1041; - - $(self.options.zIndexSelector).each(function () { - zIndex = Math.max(zIndex, parseInt($(this).css("zIndex")) + 1 || 1041); - }); - - self.$wrapper = $("
") - .hide() - .css({ - "z-index": zIndex, - "overflow-y": "auto", - "position": "fixed", - "height": "100%", - "width": "100%", - "bottom": "0", - "left": "0", - "right": "0", - "top": "0", - }) - .addClass(self.options.templateOptions.classWrapperName) - .insertBefore(backdrop.$backdrop) - .on("click", function (e) { - if (self.options.backdropOptions.closeOnClick) { - e.stopPropagation(); - e.preventDefault(); - backdrop.hide(); - } - }); - backdrop.on("hidden", function () { - if ( - self.$modal !== undefined && - self.$modal.hasClass(self.options.templateOptions.classActiveName) - ) { - self.hide(); - } - }); - self.loading = new utils.Loading({ - backdrop: backdrop, - }); - self.$wrapperInner = $("
") - .addClass(self.options.classWrapperInnerName) - .css({ - position: "absolute", - bottom: "0", - left: "0", - right: "0", - top: "0", - }) - .appendTo(self.$wrapper); - return backdrop; - }, - - _show: function () { - var self = this; - self.render.apply(self, [self.options]); - self.emit("show"); - self.backdrop.show(); - self.$wrapper.show(); - self.loading.hide(); - self.$el.addClass(self.options.templateOptions.classActiveName); - self.$modal.addClass(self.options.templateOptions.classActiveName); - registry.scan(self.$modal); - self.positionModal(); - $(window.parent).on("resize.plone-modal.patterns", function () { - self.positionModal(); - }); - $("body").addClass("modal-open"); - self.emit("shown"); - self.activateFocusTrap(); - }, - hide: function () { - var self = this; - if (self.ajaxXHR) { - self.ajaxXHR.abort(); - } - self.emit("hide"); - if (self._suppressHide) { - if (!window.confirm(self._suppressHide)) { - return; - } - } - self.loading.hide(); - self.$el.removeClass(self.options.templateOptions.classActiveName); - if (self.$modal !== undefined) { - self.$modal.remove(); - self.initModal(); - } - self.$wrapper.remove(); - if ($(".modal", $("body")).length < 1) { - self._suppressHide = undefined; - self.backdrop.hide(); - $("body").removeClass("modal-open"); - $(window.parent).off("resize.plone-modal.patterns"); - } - self.emit("hidden"); - self.$el.focus(); - }, - redraw: function (response, options) { - var self = this; - self.emit("beforeDraw"); - self.$modal.remove(); - self.$raw = $("
").append($(utils.parseBodyTag(response))); - self.render.apply(self, [options || self.options]); - self.$modal.addClass(self.options.templateOptions.classActiveName); - self.positionModal(); - registry.scan(self.$modal); - self.emit("afterDraw"); - self.activateFocusTrap(); + init: async function () { + // The implementation is a full Base.extend pattern (imperative callers + // do `new Modal(...)`), so its instance behaviour lives on the + // prototype — `Impl.init` would be the static registry initialiser. + const proto = (await import("./modal--implementation")).default.prototype; + // Defaults live with the implementation; merge them under the parsed + // options (which must win), reproducing the eager pattern's options. + this.options = $.extend(true, {}, proto.defaults, this.options); + // Graft onto this single instance so the pattern registers and behaves + // exactly as before, just with the heavy body loaded on demand. + $.extend(this, proto); + return proto.init.apply(this, arguments); }, }); diff --git a/src/pat/querystring/querystring--implementation.js b/src/pat/querystring/querystring--implementation.js new file mode 100644 index 0000000000..94279c4ff5 --- /dev/null +++ b/src/pat/querystring/querystring--implementation.js @@ -0,0 +1,930 @@ +import $ from "jquery"; +import _ from "underscore"; +import _t from "../../core/i18n-wrapper"; +import utils from "../../core/utils"; +import { Pattern as ContentbrowserPattern } from "../contentbrowser/contentbrowser"; + + +var Criteria = function () { + this.init.apply(this, arguments); +}; +Criteria.prototype = { + defaults: { + indexWidth: "20em", + remove: "", + classBetweenDtName: "querystring-criteria-betweendt", + classWrapperName: "querystring-criteria-wrapper", + classIndexName: "querystring-criteria-index", + classOperatorName: "querystring-criteria-operator", + classValueName: "querystring-criteria-value", + classRemoveName: "querystring-criteria-remove", + classResultsName: "querystring-criteria-results", + classClearName: "querystring-criteria-clear", + classDepthName: "querystring-criteria-depth", + }, + init: function ( + $el, + app, + options, + indexes, + index, + operator, + value, + baseUrl, + patternDateOptions, + patternAjaxSelectOptions, + patternRelateditemsOptions + ) { + var self = this; + self.app = app; + + self.options = { + ...self.defaults, + ...options, + }; + self.indexes = indexes; + self.indexGroups = {}; + self.baseUrl = baseUrl; + self.advanced = false; + self.initial = value; + // create wrapper criteria and append it to DOM + self.$wrapper = $("
") + .addClass(self.options.classWrapperName) + .appendTo($el); + + // Sub widgets options + self.patternDateOptions = patternDateOptions || {}; + self.patternAjaxSelectOptions = patternAjaxSelectOptions || {}; + self.patternRelateditemsOptions = patternRelateditemsOptions || {}; + // Defaults + self.patternAjaxSelectOptions = { + width: "250px", + ...self.patternAjaxSelectOptions, + }; + self.patternRelateditemsOptions = { + vocabularyUrl: + self.baseUrl + + "@@getVocabulary?name=plone.app.vocabularies.Catalog&field=relatedItems", + width: "20rem", + ...self.patternRelateditemsOptions, + }; + // Force set + self.patternRelateditemsOptions["maximumSelectionSize"] = 1; + + // Remove button + self.$remove = $("
" + self.options.remove + "
") + .addClass(self.options.classRemoveName) + .appendTo(self.$wrapper) + .on("click", function (e) { + e.stopPropagation(); + self.remove(); + }); + + // Index selection + self.$index = $("").attr( + "placeholder", + _t("Select criteria") + ); + + // list of indexes + for (const value in self.indexes) { + let options = self.indexes[value]; + if (options.enabled) { + if (!self.indexGroups[options.group]) { + self.indexGroups[options.group] = $("") + .attr("label", options.group) + .appendTo(self.$index); + } + self.indexGroups[options.group].append( + $("