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