/** * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors * SPDX-License-Identifier: AGPL-3.0-or-later */ import $ from 'jquery' import escapeHTML from 'escape-html' /** * jQuery plugin for micro templates * * Strings are automatically escaped, but that can be disabled by setting * escapeFunction to null. * * Usage examples: * * var htmlStr = '

Bake, uncovered, until the {greasystuff} is melted and the {pasta} is heated through, about {min} minutes.

' * $(htmlStr).octemplate({greasystuff: 'cheese', pasta: 'macaroni', min: 10}); * * var htmlStr = '

Welcome back {user}

'; * $(htmlStr).octemplate({user: 'John Q. Public'}, {escapeFunction: null}); * * Be aware that the target string must be wrapped in an HTML element for the * plugin to work. The following won't work: * * var textStr = 'Welcome back {user}'; * $(textStr).octemplate({user: 'John Q. Public'}); * * For anything larger than one-liners, you can use a simple $.get() ajax * request to get the template, or you can embed them it the page using the * text/template type: * * * * var $tmpl = $('#contactListItemTemplate'); * var contacts = // fetched in some ajax call * * $.each(contacts, function(idx, contact) { * $contactList.append( * $tmpl.octemplate({ * id: contact.getId(), * name: contact.getDisplayName(), * email: contact.getPreferredEmail(), * phone: contact.getPreferredPhone(), * }); * ); * }); */ /** * Object Template * Inspired by micro templating done by e.g. underscore.js */ const Template = { init(vars, options, elem) { // Mix in the passed in options with the default options this.vars = vars this.options = $.extend({}, this.options, options) this.elem = elem const self = this if (typeof this.options.escapeFunction === 'function') { const keys = Object.keys(this.vars) for (let key = 0; key < keys.length; key++) { if (typeof this.vars[keys[key]] === 'string') { this.vars[keys[key]] = self.options.escapeFunction(this.vars[keys[key]]) } } } const _html = this._build(this.vars) return $(_html) }, // From stackoverflow.com/questions/1408289/best-way-to-do-variable-interpolation-in-javascript _build(o) { const data = this._getData() try { return data.replace(/{([^{}]*)}/g, function(a, b) { const r = o[b] return typeof r === 'string' || typeof r === 'number' ? r : a }, ) } catch (e) { console.error(e, 'data:', data) } }, _getData() { if (this.elem.attr('type') === 'text/template') { return this.elem.html() } // Leave out comments, etc and take the first html element const htmlElem = $.makeArray(this.elem) .find(e => e instanceof HTMLElement) return htmlElem.outerHTML }, options: { escapeFunction: escapeHTML, }, } $.fn.octemplate = function(vars, options) { vars = vars || {} if (this.length) { const _template = Object.create(Template) return _template.init(vars, options, this) } }