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