waibu-mpa

<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: lib/class/component.js</title><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">WaibuMpa API</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="WaibuMpa.html">WaibuMpa</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#factory">factory</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/waibu-mpa" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/waibu-mpa" target="">Github</a></div><div class="navbar-item"><a id="" href="https://waibu.bajo.app/" target="">Waibu</a></div><div class="navbar-item"><a id="" href="https://bajo.app/" target="">Bajo</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">lib_class_component.js</h1></header><article><pre class="prettyprint source lang-js"><code>import baseFactory from './base-factory.js' import path from 'path' class Component { constructor ({ plugin, $, theme, iconset, locals, reply, req, scriptBlock, styleBlock } = {}) { const { get } = plugin.app.lib._ this.baseFactory = baseFactory this.plugin = plugin this.app = plugin.app this.$ = $ this.theme = theme this.iconset = iconset this.locals = locals this.reply = reply this.req = req this.cacheMaxAge = get(plugin, 'app.waibuMpa.config.theme.component.cacheMaxAgeDur', 0) this.namespace = 'c:' this.noTags = [] this.scriptBlock = scriptBlock this.styleBlock = styleBlock this.factory = {} } addScriptBlock = (type, block) => { if (!block) { block = type type = 'root' } if (typeof block === 'string') block = [block] this.scriptBlock[type] = this.scriptBlock[type] ?? [] this.scriptBlock[type].push(...block) } addStyleBlock = (type, block) => { if (!block) { block = type type = 'root' } if (typeof block === 'string') block = [block] this.styleBlock[type] = this.styleBlock[type] ?? [] this.styleBlock[type].push(...block) } /** * Loads base factories dynamically from the file system. * @async */ loadBaseFactories = async () => { const { camelCase } = this.app.lib._ const { importModule } = this.app.bajo const { fastGlob } = this.app.lib const pattern = `${this.app.waibuMpa.dir.pkg}/lib/class/factory/*.js` const files = await fastGlob(pattern) for (const file of files) { const mod = await importModule(file) const name = camelCase(path.basename(file, '.js')) this.factory[name] = mod } } /** * Retrieves a builder class or instance for a specific method. * @async * @param {string} method - The method name to retrieve the builder for. * @returns {Promise<Function|Object>} The builder class or instance. */ getBuilder = async (method) => { const { isClass } = this.app.lib.aneka let Builder = this.factory[method] if (!isClass(Builder)) Builder = await Builder.call(this) return Builder } /** * Determines the method to use based on the provided parameters. * @param {Object} params - The parameters containing the method information. * @returns {string} The determined method name. */ getMethod = (params) => { let method = params.ctag if (!this.factory[method]) method = 'any' return method } /** * Builds a tag with the given parameters and options. * @async * @param {Object} [params={}] - The parameters for the tag. * @param {Object} [opts={}] - Additional options for building the tag. * @returns {Promise<string|boolean>} The rendered HTML or `false` if the build fails. */ buildTag = async (params = {}, opts = {}) => { const { sprintf } = this.app.lib const { compile } = this.app.bajoTemplate const { escape } = this.app.waibu const { isEmpty, merge, uniq, without } = this.app.lib._ params.ctag = params.tag const method = this.getMethod(params) if (opts.attr) params.attr = merge({}, opts.attr, params.attr) this.normalizeAttr(params) params.attr.content = params.attr.content ?? '' let html if (params.attr.content.includes('%s')) html = sprintf(params.attr.content, params.html) else if (isEmpty(params.html)) html = params.attr.content if (!isEmpty(html)) params.html = params.noEscape ? html : escape(html) await this.iconAttr(params, method) await this.beforeBuildTag(method, params) const Builder = await this.getBuilder(method) const builder = new Builder({ component: this, params }) const resp = await builder.build() if (resp === false) { return false } await this.afterBuildTag(method, params) params.attr.class = without(uniq(params.attr.class), undefined, null, '') if (isEmpty(params.attr.class)) delete params.attr.class if (isEmpty(params.attr.style)) delete params.attr.style if (isEmpty(params.html)) return await this.render(params) const merged = merge({}, params.locals, { attr: params.attr }) const result = await compile(params.html, merged, { ttl: this.cacheMaxAge }) params.html = result return await this.render(params) } /** * Normalizes the attributes of the given parameters. * @param {Object} [params={}] - The parameters containing attributes to normalize. * @param {Object} [opts={}] - Additional options for normalization. */ normalizeAttr = (params = {}, opts = {}) => { const { without, keys, isString, isArray } = this.app.lib._ const { generateId } = this.app.lib.aneka params.attr = params.attr ?? {} params.attr.class = this.app.waibuMpa.attrToArray(params.attr.class) params.attr.style = this.app.waibuMpa.attrToObject(params.attr.style) if (isString(opts.cls)) params.attr.class.push(opts.cls) else if (isArray(opts.cls)) params.attr.class.push(...opts.cls) if (opts.tag) params.tag = opts.tag if (opts.autoId) params.attr.id = isString(params.attr.id) ? params.attr.id : generateId('alpha') for (const k of without(keys(opts), 'cls', 'tag', 'autoId')) { params.attr[k] = opts[k] } params.html = params.html ?? '' } /** * Renders the final HTML for the given parameters. * @async * @param {Object} [params={}] - The parameters for rendering. * @returns {Promise<string>} The rendered HTML. */ render = async (params = {}) => { const { omit, isEmpty, merge, kebabCase, isArray } = this.app.lib._ const { stringifyAttribs } = this.app.waibuMpa params.attr = params.attr ?? {} params.tag = params.attr.tag ?? ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'].includes(params.tag) ? params.tag : kebabCase(params.tag) params.attr = omit(params.attr, ['tag', 'content']) params.html = params.html ?? '' params.attrs = stringifyAttribs(params.attr) if (!isEmpty(params.attrs)) params.attrs = ' ' + params.attrs let html = isArray(params.html) ? params.html.join('\n') : params.html if (!params.noTag) { html = params.selfClosing ? `<${params.tag}${params.attrs}/>` : `<${params.tag}${params.attrs}>${params.html}</${params.tag}>` const method = this.getMethod(params) if (this.factory[method]) { // static method on Builder const Builder = await this.getBuilder(method) if (Builder.after) { html = (await Builder.after.call(this, merge({}, params, { result: html }))) ?? html } } } else if (!this.noTags.includes(params.attr.octag)) this.noTags.push(params.attr.octag) if (params.prepend) html = `${params.prepend}${html}` if (params.append) html += params.append return html } /** * Processes icon-related attributes and appends them to the HTML. * @async * @param {Object} [params={}] - The parameters containing icon attributes. * @param {string} method - The method name. */ iconAttr = async (params = {}, method) => { if (['modal', 'toast'].includes(method)) return const { groupAttrs } = this.app.waibuMpa const { merge } = this.app.lib._ for (const k in params.attr) { const v = params.attr[k] if (!['icon', 'iconEnd'].includes(k)) continue const group = groupAttrs(params.attr, ['icon', 'iconEnd']) const _params = { attr: merge(k.endsWith('End') ? group.iconEnd : group.icon, { name: v }) } const Builder = this.factory.icon const builder = new Builder({ component: this, params: _params }) await builder.build() const icon = await this.render(_params) params.html = k.endsWith('End') ? `${params.html} ${icon}` : `${icon} ${params.html}` delete params.attr[k] } } /** * Builds the `<option>` elements for a `<select>` tag. * @param {Object} params - The parameters containing options and values. * @returns {string} The generated `<option>` elements. */ buildOptions = (params) => { const { has, omit, find, isPlainObject, isArray } = this.app.lib._ const { attrToArray } = this.app.waibuMpa const items = [] if (!has(params.attr, 'options')) return let values = attrToArray(params.attr.value) if (!has(params.attr, 'multiple') && values.length > 0) values = [values[0]] const options = isArray(params.attr.options) ? params.attr.options : attrToArray(params.attr.options) for (const opt of options) { let val let text if (isPlainObject(opt)) { val = opt.value text = opt.text } else [val, text] = opt.split('|') const sel = find(values, v => val === v) items.push(`<option value="${val}"${sel ? ' selected' : ''}>${this.req.t(text ?? val)}</option>`) } params.attr = omit(params.attr, ['options']) return items.join('\n') } /** * Builds a URL with the given parameters. * @param {Object} options - The options for building the URL. * @param {Array<string>} [options.exclude] - Keys to exclude from the URL. * @param {string} [options.prefix] - The prefix for the URL. * @param {string} [options.base] - The base URL. * @param {string} [options.url] - The URL to modify. * @param {Object} [options.params={}] - Query parameters to include. * @param {boolean} [options.prettyUrl] - Whether to generate a pretty URL. * @returns {string} The built URL. */ buildUrl = ({ exclude, prefix, base, url, params = {}, prettyUrl }) => { const { isEmpty } = this.app.lib._ const { buildUrl } = this.app.waibuMpa url = url ?? (isEmpty(this.req.referer) ? this.req.url : this.req.referer) return buildUrl({ exclude, prefix, base, url, params, prettyUrl }) } /** * Builds a sentence with optional rendering and minification. * @async * @param {string|string[]} sentence - The sentence or array of sentences to build. * @param {Object} [params={}] - Parameters for rendering the sentence. * @param {Object} [extra={}] - Extra options such as wrapping or minification. * @returns {Promise<string>} The built sentence. */ buildSentence = async (sentence, params = {}, extra = {}) => { if (Array.isArray(sentence)) sentence = sentence.join(' ') const { minify, renderString } = this.app.waibuMpa if (extra.wrapped) sentence = '<w>' + sentence + '</w>' const opts = { partial: true, ext: params.ext ?? '.html', req: this.req, reply: this.reply } let html = await renderString(sentence, params, opts) if (extra.wrapped) html = html.slice(3, html.length - 4) if (extra.minify) html = await minify(html) return html } /** * Hook executed before building a tag. * @param {string} tag - The tag name. * @param {Object} params - The parameters for the tag. */ beforeBuildTag = (tag, params) => {} /** * Hook executed after building a tag. * @param {string} tag - The tag name. * @param {Object} params - The parameters for the tag. */ afterBuildTag = (tag, params) => {} /** * Builds a child tag based on a detector attribute. * @async * @param {string} detector - The attribute to detect child tags. * @param {Object} options - Options for building the child tag. * @param {string} [options.tag] - The tag name. * @param {Object} options.params - The parameters for the child tag. * @param {string} [options.inner] - Inner HTML for the child tag. */ buildChildTag = async (detector, { tag, params, inner }) => { const { has, pickBy, omit, keys } = this.app.lib._ if (has(params.attr, detector)) { const [prefix] = detector.split('-') const attr = {} const html = tag ? params.attr[detector] : undefined tag = tag ?? prefix const picked = pickBy(params.attr, (v, k) => k.startsWith(`${prefix}-`)) for (const k in picked) { attr[k.slice(prefix.length + 1)] = picked[k] } const child = await this.buildTag({ tag, params: { attr, html } }) params.html += `\n${child}` const excluded = [detector, ...keys(picked)] params.attr = omit(params.attr, excluded) } } } export default Component </code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">WaibuMpa API</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/waibu-mpa" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/waibu-mpa" target="">Github</a></div><div class="navbar-item"><a id="" href="https://waibu.bajo.app/" target="">Waibu</a></div><div class="navbar-item"><a id="" href="https://bajo.app/" target="">Bajo</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="WaibuMpa.html">WaibuMpa</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#factory">factory</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>