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