mirror of
https://github.com/XiaoDaiGua-Ray/ray-template.git
synced 2026-11-22 11:33:35 +08:00
5 lines
8.2 KiB
JavaScript
5 lines
8.2 KiB
JavaScript
import{_ as t,o as a,c as s,a3 as d}from"./chunks/framework.BNdm2jZV.js";const k=JSON.parse('{"title":"Vue 与浏览器工具","description":"","frontmatter":{},"headers":[],"relativePath":"reference/utils/browser.md","filePath":"reference/utils/browser.md"}'),i={name:"reference/utils/browser.md"};function r(o,e,l,n,h,c){return a(),s("div",null,[...e[0]||(e[0]=[d(`<h1 id="vue-与浏览器工具" tabindex="-1">Vue 与浏览器工具 <a class="header-anchor" href="#vue-与浏览器工具" aria-label="Permalink to "Vue 与浏览器工具""></a></h1><h2 id="vue-目标解析" tabindex="-1">Vue 目标解析 <a class="header-anchor" href="#vue-目标解析" aria-label="Permalink to "Vue 目标解析""></a></h2><p><code>BasicTarget<T></code> 可为元素、组件实例、ref、getter 或空值,<code>unrefElement(target, fallback?)</code> 在调用时解包;组件优先返回 <code>$el</code>。多根组件的 <code>$el</code> 未必是可操作的元素。截图、全屏、样式操作请优先绑定明确的原生 DOM ref。</p><table tabindex="0"><thead><tr><th>工具</th><th>行为</th></tr></thead><tbody><tr><td><code>call(fnOrFns, ...args)</code></td><td>调用一个函数或按顺序调用回调数组,透传参数。</td></tr><tr><td><code>renderNode(value, { defaultElement }?)</code></td><td>规范化成渲染函数。仅 <code>null</code> 或 <code>undefined</code> 用回退,<code>0</code> 和空字符串保留。</td></tr><tr><td><code>effectDispose(cleanup)</code></td><td>有当前 effect scope 时登记清理并返回 <code>true</code>,否则返回 <code>false</code>,需调用方自行释放。</td></tr><tr><td><code>watchEffectWithTarget(effect, options?)</code></td><td>对 Vue <code>watchEffect</code> 的兼容入口,返回停止句柄;在有效作用域创建时会随作用域停止。</td></tr></tbody></table><h2 id="dom、样式和尺寸" tabindex="-1">DOM、样式和尺寸 <a class="header-anchor" href="#dom、样式和尺寸" aria-label="Permalink to "DOM、样式和尺寸""></a></h2><table tabindex="0"><thead><tr><th>API</th><th>行为</th></tr></thead><tbody><tr><td><code>setClass(target, names)</code> / <code>removeClass(target, names)</code></td><td>作用于当前和后续替换的目标。支持空白分隔字符串或数组;移除时 <code>removeAllClass</code> 清空 class。</td></tr><tr><td><code>hasClass(target, names)</code></td><td>返回响应式布尔值,任一完整类名匹配即为真。只随目标引用更新,外部改 class 属性本身不会触发重算。</td></tr><tr><td><code>setStyle(target, styles)</code></td><td>支持样式对象、声明字符串或字符串数组,保留其他行内样式。支持 camelCase、CSS 自定义属性与 <code>!important</code>。</td></tr><tr><td><code>removeStyle(target, names)</code></td><td>按 CSS 名称或 camelCase 删除行内样式。</td></tr><tr><td><code>autoPrefixStyle(name)</code></td><td>返回原属性和历史前缀名的兼容映射,不执行 DOM 操作。</td></tr><tr><td><code>completeSize(value, unit = 'px')</code></td><td>数字、纯数字字符串补单位,保留百分比、CSS 关键字和表达式。</td></tr><tr><td><code>colorToRgba(color, alpha = 1, fallback?)</code></td><td>支持逗号形式 RGB/HSL 与常见 Hex。带透明度的 Hex 保留其透明度,未知格式回退到指定值或原字符串。</td></tr><tr><td><code>queryElements(selector, { defaultElement }?)</code></td><td>返回 DOM 元素数组。<code>attr:data-id</code> 等同于属性选择器。无匹配返回空数组,空或非法选择器无回退时返回 <code>null</code>。</td></tr><tr><td><code>positionSelectedMenuItem()</code></td><td>将已渲染且超出可视区的当前菜单滚入视野。调用前展开父级并等待 DOM 渲染。</td></tr></tbody></table><p>类名与样式函数内部监听目标变化,在组件 setup 或 effect scope 内创建。SSR 下访问 <code>document</code>、<code>window</code> 的方法应推迟到挂载后。</p><h2 id="文件、下载和打印" tabindex="-1">文件、下载和打印 <a class="header-anchor" href="#文件、下载和打印" aria-label="Permalink to "文件、下载和打印""></a></h2><table tabindex="0"><thead><tr><th>API</th><th>行为</th></tr></thead><tbody><tr><td><code>fileToBase64(file)</code></td><td>返回带 MIME 的 Data URL Promise,读取错误或中止会拒绝。</td></tr><tr><td><code>arrayBufferToBase64Image(buffer)</code></td><td>把 PNG 字节加上 PNG Data URL 前缀,不转换其他图像格式。</td></tr><tr><td><code>downloadBase64File(url, fileName)</code></td><td>以临时链接触发下载,清理链接。</td></tr><tr><td><code>downloadAnyFile(data, fileName)</code></td><td>接收 Data URL、Blob、File、ArrayBuffer。二进制使用临时对象 URL;Promise 完成表示已发起下载。</td></tr><tr><td><code>printDom(target, { printOptions?, domToImageOptions? })</code></td><td>先将 DOM 截成 JPEG,再发起打印预览。返回 <code>Promise<boolean></code>;失败记录错误并返回 <code>false</code>,若存在全局 Loading Bar 会同步状态。</td></tr></tbody></table><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { downloadAnyFile, fileToBase64 } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@/utils'</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> const</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> previewFile</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">file</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> File</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> fileToBase64</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(file)</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> const</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> downloadReport</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">pdf</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> Blob</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> downloadAnyFile</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(pdf, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'report.pdf'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span></code></pre></div><p><a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/403fdd589abbe37b38e1240d34f8daf2a60d3690/packages/composables/src/element.ts" target="_blank" rel="noreferrer">DOM 工具</a> · <a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/403fdd589abbe37b38e1240d34f8daf2a60d3690/packages/utils/src/files/index.ts" target="_blank" rel="noreferrer">文件工具</a> · <a href="https://github.com/XiaoDaiGua-Ray/ray-template/tree/403fdd589abbe37b38e1240d34f8daf2a60d3690/packages/composables/src/vue" target="_blank" rel="noreferrer">Vue 工具</a> · <a href="./../hooks/output.html">截图与打印 Hooks</a></p>`,11)])])}const f=t(i,[["render",r]]);export{k as __pageData,f as default};
|