Skip to content

Commit

Permalink
Fixed typo
Browse files Browse the repository at this point in the history
  • Loading branch information
pipwerks committed Mar 31, 2024
1 parent 1feaa72 commit f64e995
Show file tree
Hide file tree
Showing 22 changed files with 48 additions and 51 deletions.
4 changes: 2 additions & 2 deletions docs/.vitepress/dist/404.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/.vitepress/dist/api/changelog.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/.vitepress/dist/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
<meta name="generator" content="VitePress v1.0.0-rc.42">
<link rel="preload stylesheet" href="/assets/style.DmS7HcTt.css" as="style">

<script type="module" src="/assets/app.CpuIjLwv.js"></script>
<script type="module" src="/assets/app.DrWEoJSY.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Bu8hRsVA.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/framework.BaJ171t2.js">
<link rel="modulepreload" href="/assets/chunks/theme.BAGvGbCH.js">
<link rel="modulepreload" href="/assets/chunks/theme.DpeijKZl.js">
<link rel="modulepreload" href="/assets/api_index.md.DVAVUqIM.lean.js">
<link rel="apple-touch-icon" sizes="180x180" href="/favicons/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="96x96" href="/favicons/favicon-96x96.png">
Expand Down Expand Up @@ -61,7 +61,7 @@
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">};</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">let</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> iframe </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> PDFObject.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">embed</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;myfile.pdf&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;#my-container&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, options);</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">iframe.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">setAttribute</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;pie&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;pumpkin&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><br><h3 id="pdfjs-url" tabindex="-1">PDFJS_URL <a class="header-anchor" href="#pdfjs-url" aria-label="Permalink to &quot;PDFJS_URL&quot;"></a></h3><p>[string]. Default: <code>null</code></p><p><em>PDFObject is not affiliated with Mozilla or PDF.js, and the PDF.js code is not included with PDFObject.</em></p><p>If you would like to use PDF.js with PDFObject, you will need to specify the URL of the <a href="https://github.com/mozilla/pdf.js/wiki/Setup-PDF.js-in-a-website" target="_blank" rel="noreferrer">PDF.js viewer HTML file</a>. PDFObject will automatically pass the PDF&#39;s URL to PDF.js.</p><p>If you provide the <code>PDFJS_URL</code>, but do <strong>not</strong> set <code>forcePDFJS</code> to true, PDF.js will only be used as a fallback for browsers that do not offer native support for inline PDFs.</p><p><strong>Demo:</strong> <a href="/examples/pdfjs.html" target="_blank">Using PDF.js as a fallback</a></p><br><h3 id="forcepdfjs" tabindex="-1">forcePDFJS <a class="header-anchor" href="#forcepdfjs" aria-label="Permalink to &quot;forcePDFJS&quot;"></a></h3><p>[boolean]. Default: <code>false</code></p><p><em>PDFObject is not affiliated with Mozilla or PDF.js, and the PDF.js code is not included with PDFObject.</em></p><p>If set to true and the <code>PDFJS_URL</code> string is not null, PDFObject will attempt to use PDF.js to embed the PDF in the browser, regardless of the browser&#39;s default PDF viewer.</p><p><strong>Demo:</strong> <a href="/examples/pdfjs-forced.html" target="_blank">Forcing all embeds to be rendered by PDF.js</a></p><br><h3 id="height" tabindex="-1">height <a class="header-anchor" href="#height" aria-label="Permalink to &quot;height&quot;"></a></h3><p>[string]. Default: <code>&quot;100%&quot;</code></p><p>Will insert the height as an inline style via the <code>style</code> attribute on the the generated <code>&lt;iframe&gt;</code>. If left unspecified, PDFObject will default to 100%. Is standard CSS, supports all units, including px, %, em, and rem.</p><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">PDFObject.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">embed</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;myfile.pdf&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;#my-container&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, { height: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;500px&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span></code></pre></div><div class="tip custom-block github-alert"><p class="custom-block-title">TIP</p><p>Avoid hard-coding <code>height</code> when possible. It&#39;s safer to specify dimensions using your site&#39;s CSS.</p></div><br><h3 id="width" tabindex="-1">width <a class="header-anchor" href="#width" aria-label="Permalink to &quot;width&quot;"></a></h3><p>[string]. Default: <code>&quot;100%&quot;</code></p><p>Will insert the width as an inline style via the <code>style</code> attribute on the generated <code>&lt;iframe&gt;</code>. If left unspecified, PDFObject will default to 100%. Is standard CSS, supports all units, including px, %, em, and rem.</p><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">PDFObject.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">embed</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;myfile.pdf&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;#my-container&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, { width: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;500px&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span></code></pre></div><div class="tip custom-block github-alert"><p class="custom-block-title">TIP</p><p>Avoid hard-coding <code>width</code> when possible. It&#39;s safer to specify dimensions using your site&#39;s CSS.</p></div><br><h3 id="omitinlinestyles" tabindex="-1">omitInlineStyles <a class="header-anchor" href="#omitinlinestyles" aria-label="Permalink to &quot;omitInlineStyles&quot;"></a></h3><p>[boolean]. Default: <code>false</code></p><p>If set to true, PDFObject will not include any inline styles when generating the <code>&lt;iframe&gt;</code> element.</p><div class="warning custom-block github-alert"><p class="custom-block-title">WARNING</p><p>If you choose to omit inline styles, be sure to specify the <code>&lt;iframe&gt;</code> dimensions in your site&#39;s CSS. Failure to set dimensions may cause the PDF to be invisible (height 0).</p></div><p><strong>Demo:</strong> <a href="/examples/omit-inline-styles.html" target="_blank">Omitting inline styles</a></p><br><h3 id="suppressconsole" tabindex="-1">suppressConsole <a class="header-anchor" href="#suppressconsole" aria-label="Permalink to &quot;suppressConsole&quot;"></a></h3><p>[boolean]. Default: <code>false</code></p><p>By default, PDFObject displays error messages in the browser&#39;s JavaScript console, such as &quot;URL is not valid&quot; or &quot;This browser does not support embedded PDFs&quot;. Set <code>suppressConsole</code> to true to prevent PDFObject from displaying error messages.</p></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-48f9bb55><!--[--><!--]--><!----><nav class="prev-next" data-v-48f9bb55><div class="pager" data-v-48f9bb55><a class="VPLink link pager-link prev" href="/guide/cdn.html" data-v-48f9bb55><!--[--><span class="desc" data-v-48f9bb55>Previous page</span><span class="title" data-v-48f9bb55>NPM &amp; CDN</span><!--]--></a></div><div class="pager" data-v-48f9bb55><a class="VPLink link pager-link next" href="/api/changelog.html" data-v-48f9bb55><!--[--><span class="desc" data-v-48f9bb55>Next page</span><span class="title" data-v-48f9bb55>Changelog</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-5d98c3a5 data-v-e315a0ad><div class="container" data-v-e315a0ad><p class="message" data-v-e315a0ad>PDFObject is released under the <a href='http://pipwerks.mit-license.org'>MIT License</a>.</p><p class="copyright" data-v-e315a0ad>Copyright © 2008-2024 Philip Hutchison</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"guide_quick-start.md\":\"1cL7p_xx\",\"static_index.md\":\"CPq0k34Q\",\"vue_index.md\":\"kFAStyJq\",\"guide_index.md\":\"DfiIG4CE\",\"guide_why-pdfobject.md\":\"DHiMQeCe\",\"api_changelog.md\":\"CQiT5cFQ\",\"guide_cdn.md\":\"Dt0ptoPo\",\"examples_index.md\":\"qBaTnzbS\",\"index.md\":\"uK6ozABZ\",\"guide_browser-support.md\":\"DLwbhE_W\",\"api_index.md\":\"DVAVUqIM\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"PDFObject\",\"description\":\"Documentation for PDFObject.js\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/img/logo.png\",\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick Start\",\"link\":\"/guide/quick-start\"},{\"text\":\"Guide\",\"link\":\"/guide/\"},{\"text\":\"API\",\"link\":\"/api/\"},{\"text\":\"NPM &amp; CDN\",\"link\":\"/guide/cdn\"}],\"sidebar\":[{\"text\":\"Guide\",\"items\":[{\"text\":\"Why PDFObject?\",\"link\":\"/guide/why-pdfobject\"},{\"text\":\"Quick Start\",\"link\":\"/guide/quick-start\"},{\"text\":\"Common Use Cases\",\"link\":\"/examples/\"},{\"text\":\"Browser Support\",\"link\":\"/guide/browser-support\"},{\"text\":\"NPM &amp; CDN\",\"link\":\"/guide/cdn\"}]},{\"text\":\"API Documentation\",\"items\":[{\"text\":\"API and Examples\",\"link\":\"/api/\"},{\"text\":\"Changelog\",\"link\":\"/api/changelog\"}]},{\"text\":\"PDFObject for Vue\",\"items\":[{\"text\":\"Using the PDFObject component in Vue 3\",\"link\":\"/vue/\"}]},{\"text\":\"Extras\",\"items\":[{\"text\":\"How to embed PDFs without using JS or PDFObject\",\"link\":\"/static/\"}]}],\"footer\":{\"message\":\"PDFObject is released under the <a href='http://pipwerks.mit-license.org'>MIT License</a>.\",\"copyright\":\"Copyright © 2008-2024 Philip Hutchison\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/pipwerks/pdfobject\"}],\"search\":{\"provider\":\"local\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"vue_index.md\":\"kFAStyJq\",\"index.md\":\"uK6ozABZ\",\"guide_quick-start.md\":\"1cL7p_xx\",\"guide_cdn.md\":\"Dt0ptoPo\",\"guide_index.md\":\"DfiIG4CE\",\"examples_index.md\":\"C8M6jVK_\",\"guide_browser-support.md\":\"DLwbhE_W\",\"api_changelog.md\":\"CQiT5cFQ\",\"static_index.md\":\"CPq0k34Q\",\"guide_why-pdfobject.md\":\"DHiMQeCe\",\"api_index.md\":\"DVAVUqIM\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"PDFObject\",\"description\":\"Documentation for PDFObject.js\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/img/logo.png\",\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick Start\",\"link\":\"/guide/quick-start\"},{\"text\":\"Guide\",\"link\":\"/guide/\"},{\"text\":\"API\",\"link\":\"/api/\"},{\"text\":\"NPM &amp; CDN\",\"link\":\"/guide/cdn\"}],\"sidebar\":[{\"text\":\"Guide\",\"items\":[{\"text\":\"Why PDFObject?\",\"link\":\"/guide/why-pdfobject\"},{\"text\":\"Quick Start\",\"link\":\"/guide/quick-start\"},{\"text\":\"Common Use Cases\",\"link\":\"/examples/\"},{\"text\":\"Browser Support\",\"link\":\"/guide/browser-support\"},{\"text\":\"NPM &amp; CDN\",\"link\":\"/guide/cdn\"}]},{\"text\":\"API Documentation\",\"items\":[{\"text\":\"API and Examples\",\"link\":\"/api/\"},{\"text\":\"Changelog\",\"link\":\"/api/changelog\"}]},{\"text\":\"PDFObject for Vue\",\"items\":[{\"text\":\"Using the PDFObject component in Vue 3\",\"link\":\"/vue/\"}]},{\"text\":\"Extras\",\"items\":[{\"text\":\"How to embed PDFs without using JS or PDFObject\",\"link\":\"/static/\"}]}],\"footer\":{\"message\":\"PDFObject is released under the <a href='http://pipwerks.mit-license.org'>MIT License</a>.\",\"copyright\":\"Copyright © 2008-2024 Philip Hutchison\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/pipwerks/pdfobject\"}],\"search\":{\"provider\":\"local\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>

</body>
</html>

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Large diffs are not rendered by default.

This file was deleted.

Loading

0 comments on commit f64e995

Please sign in to comment.