UNPKG

4.72 kBMarkdownView Raw
1PDFObject is a lightweight JavaScript utility for dynamically embedding PDFs in HTML documents.
2
3Examples and documentation can be found at https://pdfobject.com.
4
5Copyright (c) 2008-2021 Philip Hutchison
6MIT-style license: http://pipwerks.mit-license.org/
7
8-----
9
10[![CDNJS](https://img.shields.io/cdnjs/v/pdfobject.svg)](https://cdnjs.com/libraries/pdfobject/)
11
12## Changelog
13
14### 2.2.6, July 2021
15* Add `title` attribute to `embed` and `iframe` elements per #248
16* Force Safari desktop to embed via iframe due to freezing bug in macOS 11 (Big Sur) per #243
17* Fixed version number per #247
18* Added note about documentation to readme file per #251
19
20### 2.2.5, March 2021
21* Expanded assumptions to counteract Chrome's deprecation of MIME type checks. Any 'modern' browser will be given a green light regardless of whether `assumptionMode` is enabled. However `assumptionMode` will still be available for browsers that are not declared modern.
22* Added `allow="fullscreen"` attribute to iframe embeds, in case anyone needs their PDFs to be rendered fullscreen.
23* Fixed Firefox user agent sniffing for edge case (thanks to David Novodchuck for the PR)
24
25### 2.2.4, October 2020
26Reinstated `typeof` check for `window` to play nice with React and NextJS.
27
28### 2.2.3, September 2020
29Version bump for NPM. Sigh.
30
31### 2.2.2, September 2020
32Fixed typo affecting `suppressConsole` functionality. Hat tip to [John Hunter](https://github.com/johnhunter) for the discovery and fix.
33
34### 2.2.1, September 2020
35Fixed typo affecting styling of iframe when forcing PDFJS.
36
37### 2.2.0, September 2020
38* **New behavior:** Dropping support for IE9 and IE10, which have practically 0 marketshare now.
39* **New behavior:** Now explicitly displaying fallback content for **all mobile devices**, even "Request Desktop" version of pages in iOS. The reasoning is simple: As of the time of this update, no mobile device (Android, iOS) natively supports embedded PDFs. This change will lead to a consistent experience across all mobile devices. PDFs can be rendered via PDF.js on mobile if embedding on mobile is a critical need. PDF.js is not included with PDFObject.
40* **New option:** Omit inline styles by setting option `omitInlineStyles` to `true`. This helps developers who use strict environments where inline styles are not allowed. Note you will be responsible for applying proper styling via your own CSS.
41* **New option:** Suppress console logging by setting option `suppressConsole` to `true`. PDFObject currently places error messages in the console if the PDF can't be embedded for some reason. This option allows you to mute those alerts.
42* **New option:** Force PDFObject to embed the PDF in an iframe (instead of an `<embed>`) by setting `forceIframe` to `true`.
43* Refactored to use more modern code conventions, such as `let` in lieu of `var`, `el.classList.add()` in place of `el.className = 'foo'`, and `myvar === undefined` in place of `typeof myvar === "undefined"`. Implemented a `let` declaration before each variable instead of the Crockford practice of one `var` per function.
44* **New option:** On macOS systems, Safari does not properly embed PDFs that have been requested via 302 URL redirection when embedding using the `<embed>` element. Setting `supportRedirect` to `true` forces PDFObject to use an `<iframe>` instead of an `<embed>` for desktop Safari. Hat tip to [John Hunter](https://github.com/johnhunter) for the discovery and fix.
45* Refactored to make code safer for server-side node.js-based environments.
46* Refactored to eliminate string-based element creation via `innerHTML`. Replaced with standard DOM methods. This helps alleviate unforeseen issues with file names. Only exception is insertion of fallback content, which is passed as a string via `innerHTML`.
47* Removed iframe scrollfix for iOS, as it is no longer needed as of iOS13. iOS 12 and lower have ~5-7% marketshare and shrinking fast.
48* Refactored codebase to make it more concise and legible.
49
50### 2.1.1, October 2018
51Improved handling of iOS to properly indicate iOS does not support embedded PDFs.
52
53### 2.1, October 2018
54Changed `assumptionMode` default from false to true. This will ensure PDFObject 2.x will work for Firefox users without requiring them to change their codebase to enable assumptionMode. All they need to do is load the latest version of PDFObject, the PDFObject utility will take care of the rest.
55
56### 2.1 (dev branch)
57January 2017: Modified to support Mozilla's removal of `navigator.mimeTypes` inspection. Added `assumptionMode` for manual override of PDFObject's default `navigator.mimeTypes` sniffing.
58
59### 2.0, April 2016
60Initial release of PDFObject 2.0. Contains breaking changes, and is not compatible with PDFObject 1.x.