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