BookStack Code Mirror - bookstack/blob - resources/js/components/index.js

   1 import addRemoveRows from "./add-remove-rows.js"
   2 import ajaxDeleteRow from "./ajax-delete-row.js"
   3 import ajaxForm from "./ajax-form.js"
   4 import attachments from "./attachments.js"
   5 import attachmentsList from "./attachments-list.js"
   6 import autoSuggest from "./auto-suggest.js"
   7 import backToTop from "./back-to-top.js"
   8 import bookSort from "./book-sort.js"
   9 import chapterContents from "./chapter-contents.js"
  10 import codeEditor from "./code-editor.js"
  11 import codeHighlighter from "./code-highlighter.js"
  12 import codeTextarea from "./code-textarea.js"
  13 import collapsible from "./collapsible.js"
  14 import confirmDialog from "./confirm-dialog"
  15 import customCheckbox from "./custom-checkbox.js"
  16 import detailsHighlighter from "./details-highlighter.js"
  17 import dropdown from "./dropdown.js"
  18 import dropdownSearch from "./dropdown-search.js"
  19 import dropzone from "./dropzone.js"
  20 import editorToolbox from "./editor-toolbox.js"
  21 import entityPermissionsEditor from "./entity-permissions-editor.js"
  22 import entitySearch from "./entity-search.js"
  23 import entitySelector from "./entity-selector.js"
  24 import entitySelectorPopup from "./entity-selector-popup.js"
  25 import eventEmitSelect from "./event-emit-select.js"
  26 import expandToggle from "./expand-toggle.js"
  27 import headerMobileToggle from "./header-mobile-toggle.js"
  28 import homepageControl from "./homepage-control.js"
  29 import imageManager from "./image-manager.js"
  30 import imagePicker from "./image-picker.js"
  31 import listSortControl from "./list-sort-control.js"
  32 import markdownEditor from "./markdown-editor.js"
  33 import newUserPassword from "./new-user-password.js"
  34 import notification from "./notification.js"
  35 import optionalInput from "./optional-input.js"
  36 import pageComments from "./page-comments.js"
  37 import pageDisplay from "./page-display.js"
  38 import pageEditor from "./page-editor.js"
  39 import pagePicker from "./page-picker.js"
  40 import permissionsTable from "./permissions-table.js"
  41 import popup from "./popup.js"
  42 import settingAppColorPicker from "./setting-app-color-picker.js"
  43 import settingColorPicker from "./setting-color-picker.js"
  44 import shelfSort from "./shelf-sort.js"
  45 import sidebar from "./sidebar.js"
  46 import sortableList from "./sortable-list.js"
  47 import submitOnChange from "./submit-on-change.js"
  48 import tabs from "./tabs.js"
  49 import tagManager from "./tag-manager.js"
  50 import templateManager from "./template-manager.js"
  51 import toggleSwitch from "./toggle-switch.js"
  52 import triLayout from "./tri-layout.js"
  53 import userSelect from "./user-select.js"
  54 import webhookEvents from "./webhook-events";
  55 import wysiwygEditor from "./wysiwyg-editor.js"
  56
  57 const componentMapping = {
  58     "add-remove-rows": addRemoveRows,
  59     "ajax-delete-row": ajaxDeleteRow,
  60     "ajax-form": ajaxForm,
  61     "attachments": attachments,
  62     "attachments-list": attachmentsList,
  63     "auto-suggest": autoSuggest,
  64     "back-to-top": backToTop,
  65     "book-sort": bookSort,
  66     "chapter-contents": chapterContents,
  67     "code-editor": codeEditor,
  68     "code-highlighter": codeHighlighter,
  69     "code-textarea": codeTextarea,
  70     "collapsible": collapsible,
  71     "confirm-dialog": confirmDialog,
  72     "custom-checkbox": customCheckbox,
  73     "details-highlighter": detailsHighlighter,
  74     "dropdown": dropdown,
  75     "dropdown-search": dropdownSearch,
  76     "dropzone": dropzone,
  77     "editor-toolbox": editorToolbox,
  78     "entity-permissions-editor": entityPermissionsEditor,
  79     "entity-search": entitySearch,
  80     "entity-selector": entitySelector,
  81     "entity-selector-popup": entitySelectorPopup,
  82     "event-emit-select": eventEmitSelect,
  83     "expand-toggle": expandToggle,
  84     "header-mobile-toggle": headerMobileToggle,
  85     "homepage-control": homepageControl,
  86     "image-manager": imageManager,
  87     "image-picker": imagePicker,
  88     "list-sort-control": listSortControl,
  89     "markdown-editor": markdownEditor,
  90     "new-user-password": newUserPassword,
  91     "notification": notification,
  92     "optional-input": optionalInput,
  93     "page-comments": pageComments,
  94     "page-display": pageDisplay,
  95     "page-editor": pageEditor,
  96     "page-picker": pagePicker,
  97     "permissions-table": permissionsTable,
  98     "popup": popup,
  99     "setting-app-color-picker": settingAppColorPicker,
 100     "setting-color-picker": settingColorPicker,
 101     "shelf-sort": shelfSort,
 102     "sidebar": sidebar,
 103     "sortable-list": sortableList,
 104     "submit-on-change": submitOnChange,
 105     "tabs": tabs,
 106     "tag-manager": tagManager,
 107     "template-manager": templateManager,
 108     "toggle-switch": toggleSwitch,
 109     "tri-layout": triLayout,
 110     "user-select": userSelect,
 111     "webhook-events": webhookEvents,
 112     "wysiwyg-editor": wysiwygEditor,
 113 };
 114
 115 window.components = {};
 116
 117 /**
 118  * Initialize components of the given name within the given element.
 119  * @param {String} componentName
 120  * @param {HTMLElement|Document} parentElement
 121  */
 122 function searchForComponentInParent(componentName, parentElement) {
 123     const elems = parentElement.querySelectorAll(`[${componentName}]`);
 124     for (let j = 0, jLen = elems.length; j < jLen; j++) {
 125         initComponent(componentName, elems[j]);
 126     }
 127 }
 128
 129 /**
 130  * Initialize a component instance on the given dom element.
 131  * @param {String} name
 132  * @param {Element} element
 133  */
 134 function initComponent(name, element) {
 135     const componentModel = componentMapping[name];
 136     if (componentModel === undefined) return;
 137
 138     // Create our component instance
 139     let instance;
 140     try {
 141         instance = new componentModel(element);
 142         instance.$el = element;
 143         const allRefs = parseRefs(name, element);
 144         instance.$refs = allRefs.refs;
 145         instance.$manyRefs = allRefs.manyRefs;
 146         instance.$opts = parseOpts(name, element);
 147         instance.$emit = (eventName, data = {}) => {
 148             data.from = instance;
 149             const event = new CustomEvent(`${name}-${eventName}`, {
 150                 bubbles: true,
 151                 detail: data
 152             });
 153             instance.$el.dispatchEvent(event);
 154         };
 155         if (typeof instance.setup === 'function') {
 156             instance.setup();
 157         }
 158     } catch (e) {
 159         console.error('Failed to create component', e, name, element);
 160     }
 161
 162
 163     // Add to global listing
 164     if (typeof window.components[name] === "undefined") {
 165         window.components[name] = [];
 166     }
 167     window.components[name].push(instance);
 168
 169     // Add to element listing
 170     if (typeof element.components === 'undefined') {
 171         element.components = {};
 172     }
 173     element.components[name] = instance;
 174 }
 175
 176 /**
 177  * Parse out the element references within the given element
 178  * for the given component name.
 179  * @param {String} name
 180  * @param {Element} element
 181  */
 182 function parseRefs(name, element) {
 183     const refs = {};
 184     const manyRefs = {};
 185
 186     const prefix = `${name}@`
 187     const selector = `[refs*="${prefix}"]`;
 188     const refElems = [...element.querySelectorAll(selector)];
 189     if (element.matches(selector)) {
 190         refElems.push(element);
 191     }
 192
 193     for (const el of refElems) {
 194         const refNames = el.getAttribute('refs')
 195             .split(' ')
 196             .filter(str => str.startsWith(prefix))
 197             .map(str => str.replace(prefix, ''))
 198             .map(kebabToCamel);
 199         for (const ref of refNames) {
 200             refs[ref] = el;
 201             if (typeof manyRefs[ref] === 'undefined') {
 202                 manyRefs[ref] = [];
 203             }
 204             manyRefs[ref].push(el);
 205         }
 206     }
 207     return {refs, manyRefs};
 208 }
 209
 210 /**
 211  * Parse out the element component options.
 212  * @param {String} name
 213  * @param {Element} element
 214  * @return {Object<String, String>}
 215  */
 216 function parseOpts(name, element) {
 217     const opts = {};
 218     const prefix = `option:${name}:`;
 219     for (const {name, value} of element.attributes) {
 220         if (name.startsWith(prefix)) {
 221             const optName = name.replace(prefix, '');
 222             opts[kebabToCamel(optName)] = value || '';
 223         }
 224     }
 225     return opts;
 226 }
 227
 228 /**
 229  * Convert a kebab-case string to camelCase
 230  * @param {String} kebab
 231  * @returns {string}
 232  */
 233 function kebabToCamel(kebab) {
 234     const ucFirst = (word) => word.slice(0,1).toUpperCase() + word.slice(1);
 235     const words = kebab.split('-');
 236     return words[0] + words.slice(1).map(ucFirst).join('');
 237 }
 238
 239 /**
 240  * Initialize all components found within the given element.
 241  * @param parentElement
 242  */
 243 function initAll(parentElement) {
 244     if (typeof parentElement === 'undefined') parentElement = document;
 245
 246     // Old attribute system
 247     for (const componentName of Object.keys(componentMapping)) {
 248         searchForComponentInParent(componentName, parentElement);
 249     }
 250
 251     // New component system
 252     const componentElems = parentElement.querySelectorAll(`[component],[components]`);
 253
 254     for (const el of componentElems) {
 255         const componentNames = `${el.getAttribute('component') || ''} ${(el.getAttribute('components'))}`.toLowerCase().split(' ').filter(Boolean);
 256         for (const name of componentNames) {
 257             initComponent(name, el);
 258         }
 259     }
 260 }
 261
 262 window.components.init = initAll;
 263 window.components.first = (name) => (window.components[name] || [null])[0];
 264
 265 export default initAll;
 266
 267 /**
 268  * @typedef Component
 269  * @property {HTMLElement} $el
 270  * @property {Object<String, HTMLElement>} $refs
 271  * @property {Object<String, HTMLElement[]>} $manyRefs
 272  * @property {Object<String, String>} $opts
 273  * @property {function(string, Object)} $emit
 274  */