/** * @file * Provides theme functions for all of Quick Edit's client-side HTML. */ (function ($, Drupal) { 'use strict'; /** * Theme function for a "backstage" for the Quick Edit module. * * @param {object} settings * Settings object used to construct the markup. * @param {string} settings.id * The id to apply to the backstage. * * @return {string} * The corresponding HTML. */ Drupal.theme.quickeditBackstage = function (settings) { var html = ''; html += '<div id="' + settings.id + '" />'; return html; }; /** * Theme function for a toolbar container of the Quick Edit module. * * @param {object} settings * Settings object used to construct the markup. * @param {string} settings.id * the id to apply to the backstage. * * @return {string} * The corresponding HTML. */ Drupal.theme.quickeditEntityToolbar = function (settings) { var html = ''; html += '<div id="' + settings.id + '" class="quickedit quickedit-toolbar-container clearfix">'; html += '<i class="quickedit-toolbar-pointer"></i>'; html += '<div class="quickedit-toolbar-content">'; html += '<div class="quickedit-toolbar quickedit-toolbar-entity clearfix icon icon-pencil">'; html += '<div class="quickedit-toolbar-label" />'; html += '</div>'; html += '<div class="quickedit-toolbar quickedit-toolbar-field clearfix" />'; html += '</div><div class="quickedit-toolbar-lining"></div></div>'; return html; }; /** * Theme function for a toolbar container of the Quick Edit module. * * @param {object} settings * Settings object used to construct the markup. * @param {string} settings.entityLabel * The title of the active entity. * @param {string} settings.fieldLabel * The label of the highlighted or active field. * * @return {string} * The corresponding HTML. */ Drupal.theme.quickeditEntityToolbarLabel = function (settings) { // @todo Add XSS regression test coverage in https://www.drupal.org/node/2547437 return '<span class="field">' + Drupal.checkPlain(settings.fieldLabel) + '</span>' + Drupal.checkPlain(settings.entityLabel); }; /** * Element defining a containing box for the placement of the entity toolbar. * * @return {string} * The corresponding HTML. */ Drupal.theme.quickeditEntityToolbarFence = function () { return '<div id="quickedit-toolbar-fence" />'; }; /** * Theme function for a toolbar container of the Quick Edit module. * * @param {object} settings * Settings object used to construct the markup. * @param {string} settings.id * The id to apply to the toolbar container. * * @return {string} * The corresponding HTML. */ Drupal.theme.quickeditFieldToolbar = function (settings) { return '<div id="' + settings.id + '" />'; }; /** * Theme function for a toolbar toolgroup of the Quick Edit module. * * @param {object} settings * Settings object used to construct the markup. * @param {string} [settings.id] * The id of the toolgroup. * @param {string} settings.classes * The class of the toolgroup. * @param {Array} settings.buttons * See {@link Drupal.theme.quickeditButtons}. * * @return {string} * The corresponding HTML. */ Drupal.theme.quickeditToolgroup = function (settings) { // Classes. var classes = (settings.classes || []); classes.unshift('quickedit-toolgroup'); var html = ''; html += '<div class="' + classes.join(' ') + '"'; if (settings.id) { html += ' id="' + settings.id + '"'; } html += '>'; html += Drupal.theme('quickeditButtons', {buttons: settings.buttons}); html += '</div>'; return html; }; /** * Theme function for buttons of the Quick Edit module. * * Can be used for the buttons both in the toolbar toolgroups and in the * modal. * * @param {object} settings * Settings object used to construct the markup. * @param {Array} settings.buttons * - String type: the type of the button (defaults to 'button') * - Array classes: the classes of the button. * - String label: the label of the button. * * @return {string} * The corresponding HTML. */ Drupal.theme.quickeditButtons = function (settings) { var html = ''; for (var i = 0; i < settings.buttons.length; i++) { var button = settings.buttons[i]; if (!button.hasOwnProperty('type')) { button.type = 'button'; } // Attributes. var attributes = []; var attrMap = settings.buttons[i].attributes || {}; for (var attr in attrMap) { if (attrMap.hasOwnProperty(attr)) { attributes.push(attr + ((attrMap[attr]) ? '="' + attrMap[attr] + '"' : '')); } } html += '<button type="' + button.type + '" class="' + button.classes + '"' + ' ' + attributes.join(' ') + '>'; html += button.label; html += '</button>'; } return html; }; /** * Theme function for a form container of the Quick Edit module. * * @param {object} settings * Settings object used to construct the markup. * @param {string} settings.id * The id to apply to the toolbar container. * @param {string} settings.loadingMsg * The message to show while loading. * * @return {string} * The corresponding HTML. */ Drupal.theme.quickeditFormContainer = function (settings) { var html = ''; html += '<div id="' + settings.id + '" class="quickedit-form-container">'; html += ' <div class="quickedit-form">'; html += ' <div class="placeholder">'; html += settings.loadingMsg; html += ' </div>'; html += ' </div>'; html += '</div>'; return html; }; })(jQuery, Drupal);