1 line
22 KiB
JavaScript
1 line
22 KiB
JavaScript
import{_ as e,c as t,o,N as a}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Module: util/vue","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/util/vue.md","lastUpdated":null}'),r={name:"api/modules/util/vue.md"},d=a('<h1 id="module-util-vue" tabindex="-1">Module: util/vue <a class="header-anchor" href="#module-util-vue" aria-label="Permalink to "Module: util/vue""></a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to "Interfaces""></a></h2><h3 id="vuefeature" tabindex="-1">VueFeature <a class="header-anchor" href="#vuefeature" aria-label="Permalink to "VueFeature""></a></h3><p>• <strong>VueFeature</strong>: <code>Object</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>[Component]</code></td><td style="text-align:left;"><a href="./../features/feature#genericcomponent"><code>GenericComponent</code></a></td></tr><tr><td style="text-align:left;"><code>[GatherProps]</code></td><td style="text-align:left;">() => <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>unknown</code>></td></tr></tbody></table><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L46" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:46</a></p><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-label="Permalink to "Type Aliases""></a></h2><h3 id="proptypes" tabindex="-1">PropTypes <a class="header-anchor" href="#proptypes" aria-label="Permalink to "PropTypes""></a></h3><p>Ƭ <strong>PropTypes</strong>: typeof <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank" rel="noreferrer"><code>Boolean</code></a> | typeof <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noreferrer"><code>String</code></a> | typeof <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank" rel="noreferrer"><code>Number</code></a> | typeof <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" target="_blank" rel="noreferrer"><code>Function</code></a> | typeof <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noreferrer"><code>Object</code></a> | typeof <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" target="_blank" rel="noreferrer"><code>Array</code></a></p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L216" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:216</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-label="Permalink to "Functions""></a></h2><h3 id="coercecomponent" tabindex="-1">coerceComponent <a class="header-anchor" href="#coercecomponent" aria-label="Permalink to "coerceComponent""></a></h3><p>▸ <strong>coerceComponent</strong>(<code>component</code>, <code>defaultWrapper?</code>): <code>DefineComponent</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Default value</th></tr></thead><tbody><tr><td style="text-align:left;"><code>component</code></td><td style="text-align:left;"><a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a></td><td style="text-align:left;"><code>undefined</code></td></tr><tr><td style="text-align:left;"><code>defaultWrapper</code></td><td style="text-align:left;"><code>string</code></td><td style="text-align:left;"><code>"span"</code></td></tr></tbody></table><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L25" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:25</a></p><hr><h3 id="computecomponent" tabindex="-1">computeComponent <a class="header-anchor" href="#computecomponent" aria-label="Permalink to "computeComponent""></a></h3><p>▸ <strong>computeComponent</strong>(<code>component</code>, <code>defaultWrapper?</code>): <code>ShallowRef</code><<code>Component</code> | <code>""</code>></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Default value</th></tr></thead><tbody><tr><td style="text-align:left;"><code>component</code></td><td style="text-align:left;"><code>Ref</code><<a href="./computed#processedcomputable"><code>ProcessedComputable</code></a><<a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a>>></td><td style="text-align:left;"><code>undefined</code></td></tr><tr><td style="text-align:left;"><code>defaultWrapper</code></td><td style="text-align:left;"><code>string</code></td><td style="text-align:left;"><code>"div"</code></td></tr></tbody></table><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L175" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:175</a></p><hr><h3 id="computeoptionalcomponent" tabindex="-1">computeOptionalComponent <a class="header-anchor" href="#computeoptionalcomponent" aria-label="Permalink to "computeOptionalComponent""></a></h3><p>▸ <strong>computeOptionalComponent</strong>(<code>component</code>, <code>defaultWrapper?</code>): <code>ShallowRef</code><<code>Component</code> | <code>""</code> | <code>null</code>></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Default value</th></tr></thead><tbody><tr><td style="text-align:left;"><code>component</code></td><td style="text-align:left;"><code>Ref</code><<a href="./computed#processedcomputable"><code>ProcessedComputable</code></a><<code>undefined</code> | <a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a>>></td><td style="text-align:left;"><code>undefined</code></td></tr><tr><td style="text-align:left;"><code>defaultWrapper</code></td><td style="text-align:left;"><code>string</code></td><td style="text-align:left;"><code>"div"</code></td></tr></tbody></table><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L185" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:185</a></p><hr><h3 id="getfirstfeature" tabindex="-1">getFirstFeature <a class="header-anchor" href="#getfirstfeature" aria-label="Permalink to "getFirstFeature""></a></h3><p>▸ <strong>getFirstFeature</strong><<code>T</code>>(<code>features</code>, <code>filter</code>): <code>Object</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>features</code></td><td style="text-align:left;"><code>T</code>[]</td></tr><tr><td style="text-align:left;"><code>filter</code></td><td style="text-align:left;">(<code>feature</code>: <code>T</code>) => <code>boolean</code></td></tr></tbody></table><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L155" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:155</a></p><hr><h3 id="iscoercablecomponent" tabindex="-1">isCoercableComponent <a class="header-anchor" href="#iscoercablecomponent" aria-label="Permalink to "isCoercableComponent""></a></h3><p>▸ <strong>isCoercableComponent</strong>(<code>component</code>): component is CoercableComponent</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>component</code></td><td style="text-align:left;"><code>unknown</code></td></tr></tbody></table><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L104" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:104</a></p><hr><h3 id="joinjsx" tabindex="-1">joinJSX <a class="header-anchor" href="#joinjsx" aria-label="Permalink to "joinJSX""></a></h3><p>▸ <strong>joinJSX</strong>(<code>objects</code>, <code>joiner</code>): <code>JSX.Element</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>objects</code></td><td style="text-align:left;"><code>Element</code>[]</td></tr><tr><td style="text-align:left;"><code>joiner</code></td><td style="text-align:left;"><code>Element</code></td></tr></tbody></table><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L94" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:94</a></p><hr><h3 id="processedproptype" tabindex="-1">processedPropType <a class="header-anchor" href="#processedproptype" aria-label="Permalink to "processedPropType""></a></h3><p>▸ <strong>processedPropType</strong><<code>T</code>>(<code>...types</code>): <code>PropType</code><<a href="./computed#processedcomputable"><code>ProcessedComputable</code></a><<code>T</code>>></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>...types</code></td><td style="text-align:left;"><a href="./vue#proptypes"><code>PropTypes</code></a>[]</td></tr></tbody></table><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L225" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:225</a></p><hr><h3 id="render" tabindex="-1">render <a class="header-anchor" href="#render" aria-label="Permalink to "render""></a></h3><p>▸ <strong>render</strong>(<code>object</code>): <code>JSX.Element</code> | <code>DefineComponent</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>object</code></td><td style="text-align:left;"><a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a> | <a href="./vue#vuefeature"><code>VueFeature</code></a></td></tr></tbody></table><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L51" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:51</a></p><hr><h3 id="rendercol" tabindex="-1">renderCol <a class="header-anchor" href="#rendercol" aria-label="Permalink to "renderCol""></a></h3><p>▸ <strong>renderCol</strong>(<code>...objects</code>): <code>JSX.Element</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>...objects</code></td><td style="text-align:left;">(<a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a> | <a href="./vue#vuefeature"><code>VueFeature</code></a>)[]</td></tr></tbody></table><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L66" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:66</a></p><hr><h3 id="rendercoljsx" tabindex="-1">renderColJSX <a class="header-anchor" href="#rendercoljsx" aria-label="Permalink to "renderColJSX""></a></h3><p>▸ <strong>renderColJSX</strong>(<code>...objects</code>): <code>JSX.Element</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>...objects</code></td><td style="text-align:left;">(<a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a> | <a href="./vue#vuefeature"><code>VueFeature</code></a>)[]</td></tr></tbody></table><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L90" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:90</a></p><hr><h3 id="renderjsx" tabindex="-1">renderJSX <a class="header-anchor" href="#renderjsx" aria-label="Permalink to "renderJSX""></a></h3><p>▸ <strong>renderJSX</strong>(<code>object</code>): <code>JSX.Element</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>object</code></td><td style="text-align:left;"><a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a> | <a href="./vue#vuefeature"><code>VueFeature</code></a></td></tr></tbody></table><h4 id="defined-in-12" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-12" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L70" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:70</a></p><hr><h3 id="renderrow" tabindex="-1">renderRow <a class="header-anchor" href="#renderrow" aria-label="Permalink to "renderRow""></a></h3><p>▸ <strong>renderRow</strong>(<code>...objects</code>): <code>JSX.Element</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>...objects</code></td><td style="text-align:left;">(<a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a> | <a href="./vue#vuefeature"><code>VueFeature</code></a>)[]</td></tr></tbody></table><h4 id="defined-in-13" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-13" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L62" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:62</a></p><hr><h3 id="renderrowjsx" tabindex="-1">renderRowJSX <a class="header-anchor" href="#renderrowjsx" aria-label="Permalink to "renderRowJSX""></a></h3><p>▸ <strong>renderRowJSX</strong>(<code>...objects</code>): <code>JSX.Element</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>...objects</code></td><td style="text-align:left;">(<a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a> | <a href="./vue#vuefeature"><code>VueFeature</code></a>)[]</td></tr></tbody></table><h4 id="defined-in-14" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-14" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L86" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:86</a></p><hr><h3 id="setrefvalue" tabindex="-1">setRefValue <a class="header-anchor" href="#setrefvalue" aria-label="Permalink to "setRefValue""></a></h3><p>▸ <strong>setRefValue</strong><<code>T</code>>(<code>ref</code>, <code>value</code>): <code>void</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>ref</code></td><td style="text-align:left;"><code>Ref</code><<code>T</code> | <code>Ref</code><<code>T</code>>></td></tr><tr><td style="text-align:left;"><code>value</code></td><td style="text-align:left;"><code>T</code></td></tr></tbody></table><h4 id="defined-in-15" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-15" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L208" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:208</a></p><hr><h3 id="setupholdtoclick" tabindex="-1">setupHoldToClick <a class="header-anchor" href="#setupholdtoclick" aria-label="Permalink to "setupHoldToClick""></a></h3><p>▸ <strong>setupHoldToClick</strong>(<code>onClick?</code>, <code>onHold?</code>): <code>Object</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>onClick?</code></td><td style="text-align:left;"><code>Ref</code><<code>undefined</code> | (<code>e?</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a>) => <code>void</code>></td></tr><tr><td style="text-align:left;"><code>onHold?</code></td><td style="text-align:left;"><code>Ref</code><<code>undefined</code> | <code>VoidFunction</code>></td></tr></tbody></table><h4 id="defined-in-16" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-16" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L119" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:119</a></p><hr><h3 id="trackhover" tabindex="-1">trackHover <a class="header-anchor" href="#trackhover" aria-label="Permalink to "trackHover""></a></h3><p>▸ <strong>trackHover</strong>(<code>element</code>): <code>Ref</code><<code>boolean</code>></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>element</code></td><td style="text-align:left;"><a href="./vue#vuefeature"><code>VueFeature</code></a></td></tr></tbody></table><h4 id="defined-in-17" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-17" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L232" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:232</a></p><hr><h3 id="unwrapref" tabindex="-1">unwrapRef <a class="header-anchor" href="#unwrapref" aria-label="Permalink to "unwrapRef""></a></h3><p>▸ <strong>unwrapRef</strong><<code>T</code>>(<code>ref</code>): <code>T</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>ref</code></td><td style="text-align:left;"><code>Ref</code><<a href="./computed#processedcomputable"><code>ProcessedComputable</code></a><<code>T</code>>></td></tr></tbody></table><h4 id="defined-in-18" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-18" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L204" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:204</a></p><hr><h3 id="wrapref" tabindex="-1">wrapRef <a class="header-anchor" href="#wrapref" aria-label="Permalink to "wrapRef""></a></h3><p>▸ <strong>wrapRef</strong><<code>T</code>>(<code>ref</code>): <code>ComputedRef</code><<code>T</code>></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>ref</code></td><td style="text-align:left;"><code>Ref</code><<a href="./computed#processedcomputable"><code>ProcessedComputable</code></a><<code>T</code>>></td></tr></tbody></table><h4 id="defined-in-19" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-19" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/vue.tsx#L200" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:200</a></p>',120),l=[d];function n(c,i,s,f,h,u){return o(),t("div",null,l)}const g=e(r,[["render",n]]);export{b as __pageData,g as default};
|