Changelog

Follow us on Twitter for updates. Our blog highlights the best new features and changes.

Newest Release

2019.4.1 – 2 Aug 2019

Model

• Fixed
  Fixes an issue where the absence of the forms feature in the license would not be properly detected on load. (#3433)

Previous Releases

2019.4 – 31 Jul 2019

See the announcement post.

UI

• Added
  Adds the new Document Editor view to allow adding/removing pages, merging documents, and more. (#3062)
• Added
  Adds support for the cy locale. (#20471)
• Added
  Adds support for inline SVGs as text for ToolbarItem#icon and ToolItem#icon. (#3299)
• Added
  Adds PSPDFKit.Configuration#theme and PSPDFKit.Theme enums to configure the theme. (#3300)
• Changed
  Changes icon theme. (#3123)
• Changed
  Changes toolbar height from 48px to 44px. (#3123)
• Changed
  Changes the thumbnail layout and styles. (#3286)
• Changed
  Improves render quality when using Standalone. (#2951)
• Fixed
  Fixes an issue where the bookmarks and annotations sidebars wouldn't show page labels. (#3137)
• Fixed
  Fixes an issue that sometimes prevented text selection after a document is loaded, unloaded, and loaded again. (#3269)
• Fixed
  Fixes an issue where multiple highlight annotations would be created for a single selection. (#3182)
• Fixed
  Fixes an issue where scrolling prevented text form field changes from being propagated. (#3210)
• Fixed
  Fixes an issue where scrolling inside note annotations would cause the page to jump in PER_SPREAD scroll mode. (#3312)
• Fixed
  Fixes an issue where EXIF orientation of JPEG image annotations were not properly applied. (#3318)
• Fixed
  Fixes an issue where the text selection cursor was visible when the pan mode was enabled. (#3325)
• Fixed
  Fixes an issue where the viewport would scroll while moving an annotation in PSPDFKit.InteractionMode.PAN mode. (#3215)
• Fixed
  Fixes an issue where the text of note annotations would be cleared after zooming. (#3183)
• Fixed
  Fixes an issue where the text of note annotations would sometimes be cleared if the note icon was hovered. (#3365)
• Fixed
  Fixes an issue with the password prompt that caused the success animation to not be displayed. (#3355)
• Fixed
  Fixes an issue where hovering annotations would move the viewport if zoomed out and not scrollable anymore (#3368).
• Fixed
  Fixes an issue where a hovered note annotation would keep showing after navigating to a different page with the keyboard. (#3359)
• Fixed
  Fixes an issue where text annotations without fontSize set would not be rendered. (#3386)
• Fixed
  Fixes an issue where pressing a non-selectable toolbar item would clear the selected state of an annotation tool. (#3191)
• Fixed
  Fixes an issue where creating a new note annotation could cause it to be placed at an unexpected point. (#3059)
• Fixed
  Fixes an issue where extra new lines would be added to a text annotation in Firefox. (#3323)

Model

• API
  Adds PSPDFKit.Instance#applyOperations() and PSPDFKit.Instance#exportPDFWithOperations() methods to modify the current document or export it with modifications. Requires document editing license feature. (#3062)
• Added
  Adds a content hash to the WebAssembly and asm.js artifacts so that they can use a long-term caching strategy. (#3255)
• Added
  Adds support for isBold and isItalic properties in widget annotations. These properties are currently not supported for printing or exporting. (#2940)
• Added
  Adds support for verticalAlign property in text and button form fields. When printing and exporting, the property is only supported for multiline text widgets. (#2895)
• Added
  Adds support for setting the default eraser cursor width before load using PSPDFKit.Options.DEFAULT_INK_ERASER_CURSOR_WIDTH. (#3334)
• Added
  Adds support for vertical alignment in single-line form fields when exporting or printing PDF files. (#C19882)
• Added
  Adds support for serializing and deserializing border properties of link annotations. (#C20359)
• Added
  Adds support for preserving the InstantJSON id in the PDF. (#C20572)
• Changed
  Changes naming scheme of chunked data. This allows for smarter preloading and caching in service worker. (#3071)
• Changed
  Improves automatic repair of AcroForms on loading documents with a large number of annotations. (#C19947)
• Changed
  Improves rendering of non ASCII text. (#C20189)
• Changed
  Improves loading performance for documents with complex outlines. (#C20279)
• Changed
  Updates libpng to version 1.6.37. (#C19851)
• Changed
  Updates Expat to version 2.2.6. (#C19868)
• Changed
  Updates libWebP to 1.0.2. (#C20040)
• Changed
  Updates Expat to version 2.2.7. (#C20545)
• Changed
  Updates openjpeg to version 2.3.1. (#C20647)
• Fixed
  Fixes asynchronous APIs to always reject instead of throwing synchronously. (#2306)
• Fixed
  Fixes an issue reading media boxes. (#C20592)
• Fixed
  Fixes an issue where some documents with dropdown fields may show an arrow when the document is flattened. (#C9539)
• Fixed
  Fixes very occasional text rendering problems. (#C20155)
• Fixed
  Fixes an assertion when importing annotations outside the page range using XFDF. (#C20424)
• Fixed
  Fixes an issue where form fields with calculation order may not be flattened correctly. (#C20434)

Example

• Added
  Adds new catalog example for the Document Editor. (#3343)
• Added
  Adds new catalog example that demonstrates the new dark mode. (#3330)
• Fixed
  Fixes an issue where custom documents did not have the same toolbar items as example documents in the examples catalog. (#3347)

Instant

• Added
  Adds support for notifying connected clients when the document changed. (#3062)

2019.3.1 – 19 Jun 2019

UI

• API
  Adds support for receiving annotations.press events from widget annotations. (#2845)
• API
  Fixes an issue where PSPDFKit.ViewState#readOnly could not be set to false in read-only documents even when PSPDFKit.Options.IGNORE_DOCUMENT_PERMISSIONS was true. (#3245)
• Fixed
  Fixes an issue where multiline text widget annotations would not be editable because of excessive padding. (#3161)
• Fixed
  Fixes an issue where the tools for note annotations were rendered in an additional tooltip instead of inside the existing note tooltip. (#3214)
• Fixed
  Fixes an issue where clicking in an annotation tooltip would deselect the annotation. (#3236)

Model

• Added
  Adds support for making individual widget annotations read only with PSPDFKit.Configuration.isEditableAnnotation. (#2845)
• Fixed
  Fixes a merging issue in Instant that caused enqueued changes to resolve incorrectly and generate a server error. (#3225)

2019.3 – 29 May 2019

See the announcement post.

UI

• Added
  Adds support for streaming search results, resulting in faster initial results. (#3058)
• Added
  Adds a toolbar for modifying the text-highlighter preset properties while on TEXT_HIGHLIGHTER interaction mode. (#3041)
• Added
  Adds an eraser tool to remove ink annotations points with the pointer. (#3057)
• Added
  Adds support for the fr-CA locale. (#3176)
• API
  Adds PSPDFKit.AnnotationPresets.toSerializableObject and PSPDFKit.AnnotationPresets.fromSerializableObject to convert annotation presets to and from serializable objects. (#3155)
• API
  Adds PSPDFKit.SearchState#minSearchQueryLength to retrieve the minimum search query length. (#3197)
• API
  Adds a minimum search query length check to PSPDFKit.Instance#search and PSPDFKit.Instance#startUISearch. (#3197)
• Changed
  Improves ink annotation creation by splitting new, distant lines into new annotations. (#1462)
• Changed
  Changes the minimum annotation size for ink and shape annotations from 128 to 16. (#3070)
• Fixed
  Fixes an issue where new lines would be duplicated in Chrome when editing a text annotation. (#3101)
• Fixed
  Fixes an issue where the default viewer styles would override the widget annotation styles on focus. (#3151)
• Fixed
  Fixes an issue where the ink annotation toolbar would not use user-provided line width presets. (#3150)
• Fixed
  Fixes an issue with read only note annotations being deletable via keyboard. (#3149)
• Fixed
  Fixes an issue with note annotations not being selectable via keyboard when read only. (#3149)
• Fixed
  Fixes an issue where the pointer cursor would change when hovering some non-editable annotations. (#3157)
• Fixed
  Fixes an issue with popover being positioned in the middle of the page even when they fit in around their reference element. (#3160)
• Fixed
  Fixes an issue with annotations being immediately deselected after selection. (#3189)

Model

• Added
  Adds support for passing page start and end indexes to Instance#search(). (#3058)
• Added
  Adds support for the hidden flag to all the supported annotation types. (#3172)
• Changed
  Improved automatic repair of AcroForms to support more document errors. (#C19834)
• Fixed
  Fixes a potential crash when processing large documents under low-memory conditions. (#C19768)
• Fixed
  Fixes an issue where broken link annotations where sent to the backend. (#C19090)

Example

• Fixed
  Fixes an issue where duplicated line annotations were clipped in the tooltips catalog example. (#3140)

2019.2.4 – 13 May 2019

UI

• Fixed
  Fixes an issue where image and stamp annotations where rendered behind widget annotations. (#3124)

Model

• Changed
  Improves error handling when creating, updating, and deleting form fields. (#3111)
• Changed
  Allow creating annotation with a user-defined createdAt or updatedAt field. (#3110)
• Changed
  Updates the Botan library version to 2.10.0. (#C19767)
• Fixed
  Fixes printing and exporting PDF files containing form field values with CJK glyphs and missing font information when using PSPDFKit Server. (#3097, #2974)
• Fixed
  Fixes an issue where Standalone on IE11 was causing some tiles to not render correctly. (#3117, #3092)
• Fixed
  Fixes a potential crash when processing large documents under low-memory conditions. (#C19768)
• Fixed
  Fixes an issue where broken link annotations where sent to the backend. (#C19090)

2019.2.3 – 29 Apr 2019

UI

• Added
  Adds support for custom page labels in the page indicator. (#3022)

Model

• Added
  Adds support for creating annotations and form fields with a user-defined ID. (#3087)
• Changed
  Improves error handling when creating, updating, and deleting annotations and bookmarks. (#3090)

Example

• Added
  Adds a new Catalog example that adds two special annotations that can be used to obscure the document. (#3023, #3024)
• Added
  Adds a new Catalog example about keeping ink signatures across page refreshes. (#2834)

2019.2.2 – 25 Apr 2019

UI

• Fixed
  Fixes an issue where changing the locale did not update the <body lang> property. (#3069)
• Fixed
  Fixes an issue where text annotations fontColor could be set to transparent (null). (#2865)
• Fixed
  Fixes an issue where the strokeDashArray property of an annotation preset would be incorrectly updated. (#3080)
• Fixed
  Fixes an issue where the thumbnails sidebar didn't have top and bottom spacing. (#1708)

Model

• Changed
  Improves server error handling. (#2807)
• Fixed
  Fixes an issue where XFDF was not being validated correctly. (#3074)

2019.2.1 – 19 Apr 2019

No web-specific changes in this version.

2019.2 – 18 Apr 2019

See the announcement post.

UI

• API
  Adds Instance#currentAnnotationPreset and Instance#setCurrentAnnotationPreset() to get and set the current active annotation preset. (#2919)
• API
  Adds Instance#setEditingAnnotation() to select an annotation and enter edit mode. (#2902)
• API
  Allow to disable the Ink Signature modal dialog by preventing the annotations.onPress event for WidgetAnnotation. (#2930)
• API
  Renames *.onPress events to *.press. (#2984):

  • API
    Renames annotations.onPress to annotations.press.
  • API
    Renames textLine.onPress to textLine.press.
  • API
    Renames page.onPress to page.press.
• Added
  Adds PSPDFKit.Options.DISABLE_KEYBOARD_SHORTCUTS to disable the viewer keyboard shortcuts. (#2909)
• Added
  Adds PSPDFKit.Configuration#customRenderers to allow adding rendering custom content along with annotations. (#2896)
• Added
  Adds keyboard navigation for annotations for better a11y. (#2963)
• Added
  Adds figcaption to images and stamp annotations that define a description property (screen readers only). (#2963)
• Added
  Adds annotations.focus and annotations.blur instance events. (#2982)
• Added
  Adds an optimization that reduces the number of points an ink annotation creates while drawing. (#2849)
• Changed
  Improves performance of large documents when using the continuous page view. (#1542)
• Changed
  Improves shape annotations scaling behavior by keeping its stroke width when resizing. (#3002)
• Fixed
  Fixes an issue where annotations would move when resized to very small sizes. (#2910)
• Fixed
  Fixes an issue when PSPDFKit.load() was interrupted by PSPDFKit.unload() before the promise has resolved. (#2334)
• Fixed
  Fixes an issue where text widget annotations isFitting property would not be correctly calculated. (#2939)
• Fixed
  Fixes a race condition when PSPDFKit.load(), PSPDFKit.unload(), and PSPDFKit.load() was called synchronously. (#2947)
• Fixed
  Fixes an issue when the same search term was searched twice consecutively. (#2994)
• Fixed
  Fixes an issue where an error message was logged when placing a new text annotation while having the thumbnail toolbar open on Standalone. (#2952)
• Fixed
  Fixes an issue where the default minimum stamp annotation size, PSPDFKit.Options.MIN_STAMP_ANNOTATION_SIZE, was so small the stamp text wouldn't fit. (#2977)
• Fixed
  Fixes an issue that caused previously reported minimumZoomLevel and maximumZoomLevel to no longer be valid if the viewport was resized. (#2907)
• Fixed
  Fixes an issue that prevented certain annotation tools for a document that does not allow changing but enables commenting. (#2663)
• Fixed
  Fixes an issue where multi line text widgets did no longer accept text when do not scroll was enabled. (#3036)
• Fixed
  Fixes an issue where annotations and form fields were not visible in Standalone mode when rotating the document on Chrome Windows. (#3037)
• Fixed
  Fixes an issue where ink annotations with a blend mode value different than normal would lose the blend mode when selected in a rotated page. (#3053)
• Fixed
  Fixes an issue where viewState events would be emitted again if an API function in the event listener caused the view state to change. (#3064)

Model

• API
  Adds Instance#getTextFromRects to extract the text intersecting a list of rects. (#3040)
• Added
  Adds support for storing custom data on annotations. (#2862)
• Added
  Adds support for optionally preloading the WASM worker. (#2886)
• Added
  Adds PSPDFKit.Options.TEXT_ANNOTATION_AUTOFIT_BOUNDING_BOX_ON_EDIT to control whether PSPDFKit should adjust the text annotations' bounding box to fit the text in the annotation when editing it. (#2894)
• Added
  Adds FontStyle to Instant JSON widget annotations. (#C18083)
• Changed
  Improves error handling when additional artifacts cannot be accessed. (#2811)
• Changed
  Changes accessing instance.connectedClients to log a warning instead of throwing an error if PSPDFKit Instant is not enabled. (#2886)
• Changed
  Loading PDF actions is now more reliable. (#C18843)
• Changed
  Update libpng to 1.6.36. (#C18972)
• Changed
  Update libjpeg-turbo to 2.0.2. (#C18973)
• Changed
  Update ICU to version 63.1. (#C18974)
• Changed
  Update zlib to 1.2.11. (#C18975)
• Fixed
  Fixes an issue where an annotation would be created even if it was invalid. (#2862)
• Fixed
  Fixes an issue where ink and shape annotations with transparent strokeColor were not being saved nor updated. (#2806)
• Fixed
  Fixes an issue where strokeDashArray was being serialized and deserialized even when its value was null. (#2924)
• Fixed
  Fixes an issue where form field values could not be saved when using PSPDFKit.AutoSaveMode.DISABLED. (#2934)
• Fixed
  Fixes an issue where annotationSelection.change would be emitted again if an API function was called from the annotationSelection.change event listener. (#2904)
• Fixed
  Fixes an issue where PSPDFKit Server may not identify form fields correctly. (#C18464)
• Fixed
  Fixes an issue where form field values may not be rendered correctly. (#C18465)
• Fixed
  Fixes an issue where some JPX images may not render correctly. (#C18648)
• Fixed
  Fixes issue with printing transparent ink strokes. (#C19102)
• Fixed
  Fixes an issue exporting instant shape annotations with transparent stroke colors. (#C19120)
• Fixed
  Fixes an issue when setting transparent colors in annotations. (#C19120)
• Fixed
  Fixes rendering of free text annotations with vertical alignment. (#C19145)
• Fixed
  Fixes an issue where edited text wasn't visible after saving the PDF. (#C19146)
• Fixed
  Fixes an issue when drawing a path using a pattern with alpha transparency. (#C19148)
• Fixed
  Fixes an issue when rendering text with an overlay blend mode. (#C19151)
• Fixed
  Fixes an issue where link annotations may not work correctly after a document is exported. (#C19222)
• Fixed
  Fixes an issue where text edited in form fields was incorrectly set in other form fields as well. (#C19236)
• Fixed
  Fixes an issue where QuadPoints of link annotations were saved to the PDF incorrectly. (#C19427)
• Fixed
  Fixes an issue where the fillColor property was ignored in Instant JSON for polyline annotations. (#C19443)
• Fixed
  Fixes a rare issue when parsing outlines. (#C19469)
• Fixed
  Fixes an issue where malformed widget annotations weren't correctly attached to the form. (#C19581)

Example

• Added
  Adds a new Catalog Example that sets up a flipbook (page curl) effect. (#2867)
• Added
  Adds a new Catalog Example about using different print modes. (#2870)
• Added
  Adds a new Catalog Example about customizing the PDF search feature. (#2859)
• Added
  Adds a new Catalog Example showcasing customization of annotation's rendered content. (#2720)

Instant

• Fixed
  Fixes an issue where updates and deletions shortly after creations were not properly propagated. (#2890)

2019.1.4 – 4 Apr 2019

UI

• Fixed
  Fixes an issue where text widget annotations height would not be editable when height was too small. (#2903)

Model

• Added
  Adds support for the cloudy border inset property (RD), transformed to a cloudyBorderInsetRect property in ellipse and rectangle annotations. (#2820)
• Fixed
  Fixes an issue where instance.createAnnotation would override the provided annotation properties with the current annotation preset properties. (#2931)
• Fixed
  Fixes an issue where annotations with a cloudy border may not be exported correctly. (#2831)

Instant

• Added
  Adds support for cloudyBorderInset property (RD) in ellipse and rectangle annotations. (#2820)

2019.1.3 – 27 Mar 2019

UI

• API
  Adds public CSS classes for annotation resize anchor handlers and outline rect: PSPDFKit-Resize-Anchor, PSPDFKit-Resize-Anchor-{position} and PSPDFKit-Selection-Outline-Rect. (#2888)
• API
  Adds public CSS classes for customizing tooltips. (#2917)
• API
  Adds Instance#setEditingAnnotation() to select an annotation and enter edit mode. (#2893)
• Added
  Adds PSPDFKit.Options.TEXT_ANNOTATION_AUTOFIT_TEXT_ON_EXPORT to control whether PSPDFKit should adjust the font size to fit the text in the annotation bounding box when exporting the annotation. (#2881)
• Changed
  Improves annotation tooltips position adjustment relative to selected annotations padding. (#2885)
• Fixed
  Fixes an issue where the instance could not be unloaded after the container node was detached from the DOM. (#2906)
• Fixed
  Fixes an issue where selected text markup annotations could not be deleted using the Backspace or Delete keys. (#2861)
• Fixed
  Fixes an issue with the latest versions of Chrome where wheel events are now passive by default and cause the host web page to be zoomed when pinching. (#2942)

Model

• Added
  Adds horizontalAlign property to WidgetAnnotation for aligning text horizontally. (#2935)
• Fixed
  Fixes an issue where form field values could not be saved when using PSPDFKit.AutoSaveMode.DISABLED. (#2934)
• Fixed
  Fixes an issue where some layers were hidden incorrectly. (#C14439)

Example

• Added
  Adds download buttons to the PWA and Catalog examples. (#2863)
• Fixed
  Fixes an issue with the iOS iPad full screen demo in the magazine catalog example. (#2750)
• Changed
  Upgrade React example to latest versions. (#2926)

2019.1.2 – 28 Feb 2019

UI

• Added
  Adds SELECTION_OUTLINE_PADDING and RESIZE_ANCHOR_RADIUS callbacks and SELECTION_STROKE_WIDTH to the configurable PSPDFKit.Options object. (#2793)
• Fixed
  Fixes an issue where ToolItem in annotation tooltip would break the viewer due to a runtime error. (#2833)
• Fixed
  Fixes PrintMode.EXPORT_PDF in Safari by not opening the PDF to print in a new window. (#2835)

Model

• Changed
  Do not check for installed Acrobat when trying to print in EXPORT_PDF print mode on IE11. (#2826)
• Fixed
  Fixes an issue where PSPDFKit.FormFields#SignatureFormField was not exposed despite being in the public documentation. (#2823)
• Fixed
  Fixes an issue with the random number generator for Standalone on IE11 and Edge. (#2802)

2019.1.1 – 14 Feb 2019

UI

• Fixed
  Fixes an issue where image and stamp annotations were rendered in front of widget annotations. (#2776)
• Fixed
  Fixes an issue where the sidebar was having the incorrect height. (#2775)
• Fixed
  Fixes an issue that prevent bookmarks from properly being saved when using AutoSaveMode.INTELLIGENT. (#2778)

Model

• Changed
  Improves support for large documents when using PSPDFKit for Web Standalone. (#2792)

2019.1 – 7 Feb 2019

See the announcement post.

UI

• API
  Adds ViewState#sidebarPlacement to control the direction of the sidebar. (#2691)
• API
  Adds transformation APIs to transform between PDF page space and the client space. (#2546)
• API
  Adds an API to calculate a fitting bounding box for text annotations. (#2679)
• API
  Adds setEditableAnnotationTypes and isEditableAnnotation to granularly define permissions for annotations. (#1756)
• Added
  Adds a cloudy border tool to polygon, rectangle and ellipse annotation toolbars. (#2528)
• Added
  Adds pinch zoom support on desktop devices with trackpad, or mouse on Chrome, Firefox and Safari. (#1263)
• Added
  Adds swipe support for per spread view on desktop devices with touch on Chrome, Firefox and Safari. (#2765)
• Changed
  Improves ink annotation creation on the UI by splitting the annotation if its properties change. (#2683)
• Changed
  Changes the default font families of the viewer to include more system fonts. (#2710)
• Fixed
  Fixes an issue where PSPDFKit.defaultStampAnnotationTemplates would need to be copied in order to modify it. (#2725)
• Fixed
  Fixes an issue where text form fields font auto sizing feature was not accounting for field padding. (#2685)
• Fixed
  Fixes an issue where checkbox fields checkmarks would overflow the field's bounds. (#2689)
• Fixed
  Fixes an issue by changing the default text highlighter and highlighter tool to match text selection highlight creation. (#2694)
• Fixed
  Fixes a bug when initializing a sidebar with the initialViewState API. (#2216)
• Fixed
  Fixes an issue where the dragging of the sidebar was delayed and could cause the dragging to continue although the pointer was released. (#2686)
• Fixed
  Fixes the default padding of annotation tooltip items. (#2709)
• Fixed
  Fixes an issue with note annotations permissions when annotationAndForms is set as document permission. (#2663)
• Fixed
  Fixes layout config drop down menu would not close when click outside. (#2708)

Model

• Added
  Adds a cloudy border intensity field to polygon, rectangle and ellipse annotation models. (#2528)
• Added
  Adds annotations models default values to PSPDFKit.defaultAnnotationPresets. (#2718)
• Added
  Adds PSPDFKit.Options.IGNORE_DOCUMENT_PERMISSIONS to ignore the document permissions and enable all the features. (#2470)
• Added
  Adds support for cloudy borders in shape annotations and free text annotations via Instant JSON. (#C18547)
• Changed
  Improves initial text parsing performance. (#C18534)
• Fixed
  Fixes an issue where creating an ink signature in combination with an event handler could trigger an error. (#2695)
• Fixed
  Fixes an issue where form field's doNotSpellCheck was mistyped as doNotSpellcheck. (#2729)
• Fixed
  Fixes an issue where instances of the core PDF engine deamon failed to close. (#C18551)
• Fixed
  Fixes an issue with importing/exporting color values which could lead to unnecessary appearance stream regeneration in the core engine. (#C18428)
• Fixed
  Fixes an issue where some image annotations may be rendered incorrectly. (#C18731)

Example

• Added
  Adds a new Catalog Example showcasing drag and drop and other advanced customization options. (#2679)

2018.7.1 – 15 Jan 2019

UI

• API
  Adds public CSS classes for annotation toolbars toolboxes. (#2392)
• Added
  Adds persistence of properties to ink signatures. (#2479)
• Added
  Adds locked aspect ratio resize by keeping Shift pressed while resizing an annotation with the UI. (#2531)
• Added
  Adds automatic font size calculation for combo box widgets. (#2644)
• Added
  Adds configurable ink signatures save mode. (#2593)
• Added
  Adds PSPDFKit-Icon-<IconType> public CSS classes to style individual icons. (#2664)
• Added
  Adds 4pt, 6pt, 8pt, and 200pt to the list of possible font sizes for text annotations. (#C18485)
• Fixed
  Fixes an issue in Edge where the annotation toolbar layout would break when changing the font size. (#2225)
• Fixed
  Fixes an issue where rotating the page could eventually trigger a JavaScript TypeError. (#2622)
• Fixed
  Fixes an issue where markup annotations changes were not being persisted in the annotation preset. (#2621)
• Fixed
  Fixes an issue where the blend modes toolbox button would show the wrong title and aria-label, or no title nor aria-label. (#2614)
• Fixed
  Fixes an issue where ink signatures were created at the current page index instead of the related signature form field. (#2642)
• Fixed
  Fixes wrong computed document height when opening a sidebar. (#2652)
• Fixed
  Fixes an issue where the minimumZoomLevel and maximumZoomLevel where wrong on landscape documents. (#2661)
• Fixed
  Fixes an issue with custom ToolbarItem where the selected property was ignored. (#2662)
• Fixed
  Fixes an issue where the selected item was not shown in the list of font sizes for text annotations. (#2672)
• Fixed
  Fixes an issue when inferring the baseUrl threw errors when importing PSPDFKit. (#2666)
• Fixed
  Fixes an issue where some overflown text fields would not adjust the font size. (#2677)
• Fixed
  Fixes an issue while highlighting where the current highlight annotation would disappear if clicked. (#2675)

Model

• API
  Expose WidgetAnnotation interface. (#2640)
• Added
  Adds automatic fallback to non-streaming WASM compilation when the wasm file mime-type is not set to application/wasm. (#2624)
• Fixed
  Fixes an issue with license code verification on Electron. (#2668)
• Fixed
  Fixes a problem importing/exporting color values. This could lead to unnecessary appearance stream regeneration. (#C18428)

Example

• Changed
  Upgrades the Electron example app to use Electron 4.0. (#2668)

2018.7 – 18 Dec 2018

See the announcement post.

UI

• API
  Adds public CSS class for active Dropdown Buttons. (#2466)
• API
  Adds missing public CSS classes for shape Toolbar Buttons. (#2532)
• API
  Adds public CSS class for Text Highlighter Buttons. (#2532)
• API
  Adds ToolbarItem#node to render custom DOM nodes in the main toolbar. (#2520)
• API
  Adds Configuration#annotationTooltipCallback to configure a tooltip with tools for each annotation type. (#2540)
• API
  Adds ViewState#enableAnnotationToolbar to enable or disable the annotation toolbar on select. (#2540)
• Added
  Adds optional smooth line rendering for ink annotations and ink signatures. (#1588)
• Added
  Adds new stroke color icon to avoid confusion for non closed shapes (ink, lines, polylines). (#2508)
• Added
  Adds a text highlighter tool. (#2468)
• Added
  Adds support for deleting selected annotations with Backspace and Delete keys. (#1405)
• Changed
  Improves contrast of annotation toolbar icons. (#2508)
• Fixed
  Fixes the mixup between the border color and the fill color icons. (#2508)
• Fixed
  Fixes an issue where the last point of an ink annotation line being created was lost when releasing the pointer. (#2518)
• Fixed
  Fixes an issue where stamps UI would break when editing text. (#2445)
• Fixed
  Fixes an issue where some standard stamp annotations were being rendered as Custom. (#2467)
• Fixed
  Fixes an issue where stamp annotations were rendered rotated when viewing rotated documents. (#2486)
• Fixed
  Fixes bookmarks sidebar translations to be more accessible and self explanatory. (#2478)
• Fixed
  Fixes an issue in Firefox 60+ where the first text line of newly created note annotations would be deleted when pressing space. (#2482)
• Fixed
  Fixes an issue with SidebarMode.BOOKMARKS not being activatable via public API. (#2500)
• Fixed
  Fixes an issue where note annotations content new lines were not being rendered. (#2487)
• Fixed
  Fixes an issue where annotations could be deleted even though read only mode is enabled. (#2505)
• Fixed
  Fixes an issue where certain annotation toolbar items did not share the same height. (#2508)
• Fixed
  Fixes an issue where annotations hit test area was too wide. (#2127)
• Fixed
  Fixes an issue where setting className and icon for the layout-config got ignored. (#2536)
• Fixed
  Fixes an issue where the annotation toolbar for note annotations was shown when in read only mode. (#2461)
• Fixed
  Fixes an issue where text selection using the touch mode in Edge was not properly working. (#2407)
• Fixed
  Fixes an issue where annotations with the noView flag set were selectable, and were being rendered if selected. (#2476)
• Fixed
  Fixes an issue where stamp annotations added to rotated PDF pages were not rendered correctly. (#2521)
• Fixed
  Fixes an issue in IE11 where rendered squiggle annotations would spill out of its bounding box when zoomed. (#2553)
• Fixed
  Fixes an issue where the styleSheets array passed to PSPDFKit.load() was cleared after the first use. (#2561)
• Fixed
  Fixes an issue where the wrong onPress handler for multiple items in a dropdown group was triggered. (#2565)
• Fixed
  Fixes an issue where rendered squiggle annotations would shrink when the viewport was zoomed out. (#2555)
• Fixed
  Fixes an issue where startUISearch() did not emit the same events as a user-driven UI search. (#2573)
• Fixed
  Fixes an issue where the loading indicator for stamp and image annotations would be incorrectly positioned in IE11. (#2594)
• Fixed
  Fixes an issue where the stamp picker would have an excessive height in iOS devices. (#2597)

Model

• API
  Adds PSPDFKit.Options to modify default configurations. (#2171)
• Added
  Adds a new rotation property to TextAnnotation, ImageAnnotation, and StampAnnotation. (#2521)
• Added
  Adds ToolItem interface which ToolbarItem now extends. (#2540)
• Changed
  Improves automatic font size calculation for text widgets. (#C18095)
• Changed
  Improves handling of malformed documents when parsing the extended graphics state. (#C18057)
• Fixed
  Fixes an issue where custom stamps were not being correctly validated. (#2477)
• Fixed
  Fixes an issue where our previous change to force asm.js on Safari 11 was not working on some versions of Safari. (#2498)
• Fixed
  Fixes an issue where the Parent object was not checked when putting widgets into form fields. (#C17796)
• Fixed
  Fixes an issue where attachments provided via InstantJSON were not created upon initialization. (#2530)
• Fixed
  Fixes an issue when importing an annotation from XFDF when the bounding box is too large. (#C17901)
• Fixed
  Fixes issues when importing annotations on rotated pages using InstantJSON. (#C17814)
• Fixed
  Fixes some visualization issues with markup annotations, specially on rotated pages. (#C17889, #C18002, #C18024)
• Fixed
  Fixes an issue where squiggly annotations may not be created correctly on rotated pages. (#C17950)
• Fixed
  Fixes text parsing issue noticed on a very limited number of documents. (#C18032)

2018.6.1 – 16 Nov 2018

UI

• Fixed
  Fixes broken PDF text parsing in Firefox, Edge, and IE 11. (#2473)

2018.6 – 13 Nov 2018

See the announcement post.

UI

• API
  Adds viewStateFromOpenParameters() to apply open parameters to a ViewState. (#1161)
• API
  Adds Configuration#disableOpenParameters to disable PDF Open Parameters support. (#1161)
• API
  Adds Configuration#renderPageCallback to draw arbitrary objects onto the page layer. (#1281)
• API
  Adds Instance#getSelectedRectsPerPage() to get a list of all selected text rects in PDF page coordinates. (#2252)
• API
  Adds a new toolbar item sidebar-bookmarks. (#2388)
• API
  Adds public CSS class PSPDFKit-Stamp-Annotation for stamp annotations. (#2332)
• API
  Adds public CSS class PSPDFKit-Toolbar-Button-Stamp-Annotation to the new stamp toolbar button. (#2432)
• API
  Adds public CSS class PSPDFKit-Toolbar-Button-Icon for toolbar button icons. (#2435)
• API
  Adds a new update events for ink signatures: inkSignatures.update. It will fire whenever a signature is either created, updated, or deleted. (#2363)
• Added
  Adds support for stamp annotations. (#2332)
• Added
  Adds support for viewing and creating bookmarks. (#2278)
• Added
  Adds support for comb of characters text input fields. (#2111)
• Added
  Adds translations for colors, highlighter and pen. (#2311)
• Added
  Adds support for preventing text from being copied. (#2274)
• Added
  Adds support for some PDF Open Parameters. (#1161)
• Changed
  Improves accessibility of modal dialogs. (#2291)
• Changed
  Improves the word breaking behavior for text annotations. (#2261)
• Changed
  Increases the maximum resolution of render page APIs. (#2419)
• Removed
  Removes smooth scrolling in toolbar due to a known iOS Safari issue. (#2427)
• Fixed
  Fixes a bug where an initial page index was not properly applied. (#2317)
• Fixed
  Fixes an issue with PSPDFKit.I18n.messages exposing messages as ES6 modules. (#2295)
• Fixed
  Fixes an issue where keyboard page navigation would not work in IE 11. (#2299)
• Fixed
  Fixes an issue where a dropdown group with a single item would still show as a dropdown group. (#2284)
• Fixed
  Fixes an issue where it was not possible to opt-out an item from a dropdown group. (#2283)
• Fixed
  Fixes an issue where the pager toolbar item would disappear on MSEdge. (#2320)
• Fixed
  Fixes an issue when creating text markup annotations spanning across multiple pages. (#2337)
• Fixed
  Fixes an issue where some entries of a combo box input where not properly rendered. (#2322)
• Fixed
  Fixes crashes when using the DOM print mode on mobile devices and IE 11 by disabling high resolution printing. (#1882, #2089)
• Fixed
  Fixes a double update issue when changing attributes of text annotations. (#2261)
• Fixed
  Fixes an issue where a not supported font would not be shown as selected. (#2261)
• Fixed
  Fixes an issue where empty pages where appended on some browsers when using DOM printing. (#1521)
• Fixed
  Fixes an issue where image annotation rendering was sometimes failing when using a standalone deployment. (#2390)
• Fixed
  Fixes an issue where annotations with a NoView flag set were not printed. (#2350)
• Fixed
  Fixes an issue where text selection was not properly cleared when the pan tool was enabled. (#2391)
• Fixed
  Fixes an issue where toolbar items with data URL icons appear shifted to the left. (#2273)
• Fixed
  Fixes an issue where image annotations had the opacity applied twice. (#2436)
• Fixed
  Fixes an issue where annotations with strokeWidth equal to 0 and no fill color would be rendered. (#2454)
• Fixed
  Fixes an issue in IE11 and Edge where opacity settings would not be applied to image annotations. (#2409)

Model

• API
  Changed annotation APIs to not throw synchronously but reject with an Error instead. (#2305)
• API
  Adds Configuration#overrideMemoryLimit to allow overriding the default memory limit for PSPDFKit for Web Standalone. (#1743)
• API
  Adds Bookmark and instance methods for managing bookmarks. (#2388)
• Fixed
  Fixes an issue where the background of ink annotations was not printed. (#2041)
• Fixed
  Fixes an issue where annotations with strokeWidth equal to 0 would have it set to 5 (#2454)

Core

• API
  Adds Annotations.StampAnnotation for stamp annotations. (#2332)
• Changed
  Forces asm.js on Safari 11. (#2361)
• Fixed
  Fixes form flattening with no fonts available leads to exported PDFs with empty fields. (#C17538)

Example

• Added
  Adds Typescript example. (#2394)
• Changed
  Updates PSPDFKit for Electron example to Electron 3. (#2098)
• Fixed
  Fixes a layout issue in the PWA example. (#2351)

Instant

• Added
  Adds support for stamp annotations Instant. (#2332)
• Added
  Adds support for stamp annotations to Instant JSON. (#2332)
• Added
  Adds support for bookmarks Instant. (#2278)
• Added
  Adds support for bookmarks to Instant JSON. (#2278)

Documentation

• Added
  Adds search to our API documentation. (#2294)
• Removed
  Removes new to construct Immutable.List types. (#2300)

2018.5.2 – 16 Nov 2018

UI

• Fixed
  Fixes broken PDF text parsing in Firefox, Edge, and IE 11. (#2473)

2018.5.1 – 10 Sep 2018

UI

• Added
  Adds public CSS class PSPDFKit-Image-Annotation for image annotations. (#2264)
• Changed
  Improves usability for invalid image annotations. (#2266)
• Fixed
  Fixes a bug that allowed the use of PDFs for image annotations via the toolbar button. (#2262)
• Fixed
  Fixes an issue where the loading indicator for image annotations was shown in a wrong position. (#2260)
• Fixed
  Fixes an issue in Safari where blend modes were not applied to ink annotations while drawing them or changing their blend mode. (#2251)

Model

• Changed
  Improves error messages for invalid image attachments. (#2259)
• Fixed
  Fixes an issue where some PDF pages could not be inserted as attachments for images. (#C16729)

2018.5 – 5 Sep 2018

See the announcement post.

UI

• API
  Adds new methods to control annotation presets: Instance#annotationPresets, Instance#setAnnotationPresets, and PSPDFKit#defaultAnnotationPresets. (#2077)
• API
  Adds Configuration#annotationPresets and the annotationPresets.update event to make it possible to persist annotation presets. (#2077)
• API
  Adds ToolbarItem#preset to create annotations with different presets. (#2077)
• API
  Adds Configuration#enableServiceWorkerSupport to not bypass service workers when loading stylesheets. (#1963)
• API
  Removes InteractionMode.LAYOUT_CONFIGURATION. (#1653)
• Added
  Adds support for image annotations. (#1202)
• Added
  Adds the document outline sidebar. (#2137)
• Added
  Adds the document annotations sidebar. (#2145)
• Added
  Adds new highlighter and arrow tool. (#2129)
• Added
  Adds support for vertical alignment of text annotations. (#1608)
• Added
  Adds persistence to user changes in the annotation toolbars by modifying its associated preset. (#2077)
• Added
  Adds public CSS classes for each button in the layout configuration option. (#2146)
• Added
  Adds .PSPDFKit-Text-Markup-Annotation-selected to match selected text markup annotations. (#2109)
• Changed
  Improves performance of zooming and scrolling. (#2083)
• Fixed
  Fixes an issue where all squiggle annotations would inherit the same color of the last one created. (#2077)
• Fixed
  Fixes an issue where styles were not applied to widgets. (#1831)
• Fixed
  Fixes an issue where line caps were not being hidden in short lines. (#2147)
• Fixed
  Fixes an issue where some shape annotations were printed cropped. (#2149)
• Fixed
  Fixes an issue where relative URLs in CSS did not resolve correctly. (#1963)
• Fixed
  Fixes an issue where grouped toolbar buttons could not be disabled. (#2123)
• Fixed
  Fixes overflowing toolbar items are not visible. Now the toolbar can scroll horizontally. (#2189)

Model

• API
  Adds Annotations.ImageAnnotation for image annotations. (#1202)
• API
  Adds OutlineElement and Instance#getDocumentOutline to expose the document outline. (#2137)
• API
  Adds Instance#createAttachment and Instance#getAttachment to create attachments that can be used for image annotations. (#2152)
• API
  Adds Annotations.InkAnnotation#isSignature to indicate when an ink annotation was created as signature. (#2112)
• Fixed
  Fixes an issue where form fields imported via XFDF where not showing up Instant JSON. (#C16463)

Example

• Added
  Adds PWA (progressive web app) example. (#1996)
• Added
  Adds Vue.js example. (#2072)
• Changed
  Updates dependencies of Webpack example. (#2099)

Instant

• Added
  Adds support for image annotations and attachments to Instant. (#1202)
• Added
  Adds support for image annotations and attachments to Instant JSON. (#1202)

2018.4.3 – 16 Nov 2018

UI

• Fixed
  Fixes broken PDF text parsing in Firefox, Edge, and IE 11. (#2473)

2018.4.2 – 24 Aug 2018

Model

• Fixed
  Fixes an issue with XFDF on rotated pages. (#2158)

2018.4.1 – 31 Jul 2018

UI

• Added
  Adds option to specify the number of password retries. (#2067)
• Added
  Adds PSPDFKit-Annotation-Widget-read-only as public CSS class. (#1646)
• Changed
  Improves text selection behavior when there is padding between the individual text lines. (#2090)
• Changed
  Changes PSPDFKit.unload() to be idempotent if a DOM element is passed without PSPDFKit for Web being mounted. (#2076)
• Fixed
  Fixes an issue where pinching zoomed the whole viewport. (#2070)
• Fixed
  Fixes an issue where locale does not attempt to fallback. (#2078)
• Fixed
  Fixes an issue with clipping annotations to the page. (#2075)
• Fixed
  Fixes an issue where the viewport was too large when zoomed in. (#2086)
• Fixed
  Fixes an issue where the text was not updated when changing the locale. (#2031)
• Fixed
  Fixes an issue with custom CSS on Firefox. (#2104)
• Fixed
  Fixes an issue with a missing translation. (#2092)
• Fixed
  Fixes an issue with unnecessary custom overlay items re-rendering. (#2107)

Core

• Changed
  Improves setup experience by adding better error messages. (#2085)

2018.4 – 12 Jul 2018

See the announcement post.

UI

• Added
  Adds support for blend modes on Ink and Markup Annotations. (#1878)
• Added
  Adds support for shape annotations: line, rectangle, ellipse, polyline and polygon. (#1203)
• Added
  Adds public CSS classes for the Layout Config toolbar item and dropdown for easy styling. (#2064)
• Changed
  Improves style of disabled buttons. (#1920)
• Changed
  Changes the order of PSPDFKit.defaultToolbarItems. (#2039)
• Fixed
  Fixes a rendering issue that resulted into blurry pages at certain zoom levels. (#1824)
• Fixed
  Fixes an issue with IE 11 when editing text annotations. (#1958)
• Fixed
  Fixes an issue with IE 11 where pasted text got duplicated. (#1850)
• Fixed
  Fixes a bug where annotations where immediately draggable when using the setSelectedAnnotation API method. (#1969)
• Fixed
  Fixes a regression where form fields were read-only when the document permissions didn't permit modification. (#1976)
• Fixed
  Fixes an issue where setting the ViewState threw an Error when in read-only mode. (#1952)
• Fixed
  Fixes an issue where forms were not enabled when document permissions didn't permit modifying annotations and forms. (#1999)
• Fixed
  Fixes an issue when changing the properties of an ink annotation before drawing the first line when Instant is disabled. (#2004)
• Fixed
  Fixes an issue where annotation toolbars and some toolbar buttons included undefined as class name. (#2013)
• Fixed
  Fixes an issue with long text overflowing in the layout configuration dropdown. (#2023)
• Fixed
  Fixes an issue where the delete icon in the annotation toolbar was visible although the annotation was not created yet. (#2043)
• Fixed
  Fixes an issue where the text-align icon was not correct. (#2042)
• Fixed
  Fixes an issue with forms not rendering in standalone when rotating pages. (#2057)
• Fixed
  Fixes an issue which prevented scrolling modals on mobile. (#2046)

Model

• API
  Removes deprecated Instance#renderCover. (#1431)
• Fixed
  Fixes an issue where the default Annotation#name was sometimes out of sync with Annotation#id. (#1980)
• Fixed
  Fixes an issue where annotation changes made via the API where not automatically saved to the server when Instant is disabled. (#2005)
• Fixed
  Fixes an issue where invalid annotations crash the application. (#2004)
• Fixed
  Fixes an issue where the Instant Document JSON returned a permanent but no changing PDF ID. (#1847)

Example

• Fixed
  Fixes a bug in the Rails example, where restarting the example container did not work. (#1971)

Instant

• Fixed
  Fixes an issue where the annotation payload for Instant was including unnecessary information. (#1980)

2018.3.3 – 16 Nov 2018

UI

• Fixed
  Fixes broken PDF text parsing in Firefox, Edge, and IE 11. (#2473)

2018.3.2 – 20 Jun 2018

UI

• Fixed
  Fixes a regression where readOnly form fields where not properly disabled. (#1921)
• Fixed
  Fixes an issue with selection grippers not working on Windows touch devices. (#1925)
• Fixed
  Fixes an issue with contextual menus overlap the text markup annotation popover on some touch devices. (#1925)
• Fixed
  Fixes an issue where creating an ink annotation with a background color caused the page content to disappear. (#1916)
• Fixed
  Fixes an issue with stylesheets not being cached by a user defined service worker. (#1928)

Model

• Fixed
  Fixes an issue with the newly introduced isFitting property for text annotations. (#C15597)
• Fixed
  Fixes an issue where search did not work in IE 11 when using standalone. (#1883)
• Fixed
  Fixes an issue with all the custom overlay items for a page being removed in bulk. (#1942)

2018.3.1 – 4 Jun 2018

UI

• API
  Adds Configuration#disableIndexedDBCaching to force disable caching of the WASM module when IndexedDB is supported. (#1905)
• API
  Adds Configuration#disableWebAssemblyStreaming to force disable WebAssembly streaming instantiation. (#1907)
• API
  Adds Configuration#standaloneInstancesPoolSize to configure the number of disposed instances to keep in memory for fast reuse. (#1908)
• Fixed
  Fixes an issue where forms were not rendered as read only when the server's write permission was not set. (#1870)

Model

• Fixed
  Fixes a crash when setting the interactionMode and enabling readOnly mode at the same time. (#1901)

Instant

• Added
  Adds annotation note to Instant JSON. (#C15404)

2018.3 – 31 May 2018

See the announcement post.

UI

• API
  Adds PSPDFKit.Annotations.toSerializableObject and PSPDFKit.Annotations.fromSerializableObject to convert annotations to and from serializable objects which adhere to the InstantJSON format. (#1704)
• Added
  Adds support for touch events on desktop browsers. (#1459)
• Added
  Adds support for ink signatures. (#1704)

  • API
    Adds Instance#getInkSignatures to retrieve the list of ink signatures.
  • API
    Adds Instance#setInkSignatures to set or update the list of ink signatures.
  • API
    Adds Configuration#populateInkSignatures to load the initial list of ink signatures.
• Added
  Adds public CSS classes to Link Annotations for easy styling. (#1860)
• Changed
  Improves the file size of the required style sheet. (#1795)
• Changed
  Improves rendering performance when resizing the sidebar and when switching between page modes. (#1859)
• Fixed
  Fixes an with responsive toolbar groups including items from other groups. (#1784)
• Fixed
  Fixes responsive behavior of the text annotation toolbar. (#1800)
• Fixed
  Fixes a regression when copying text on IE 11. (#1454)
• Fixed
  Fixes an issue where multi line text widgets that have an automatic text size had a font size that was too big. (#1844)
• Fixed
  Fixes opacity of Text Annotations in editable mode. (#1799)
• Fixed
  Fixes an issue where opacity was being doubled on editing mode text annotations. (#1799)

Model

• Added
  Adds a new annotation event: annotations.load that is triggered whenever annotations are loaded from the underlying data source. This was previously firing annotations.create. (#1690)
• Added
  Adds support for fontSize property on widget annotations. (#1747)
• Added
  Adds Annotation#name to all annotation records. This will default to the annotation identifier to mimic the behavior of our other platforms. (#C14856)
• Added
  Adds support for dynamic code loading to reduce bundle size. (#1755)
• Added
  Adds new instance events for ink signatures: inkSignatures.create, inkSignatures.update, inkSignatures.delete. (#1704)
• Added
  Adds support for password protected PDFs. (#1632)
• Fixed
  Fixes an issue where the loading of the initial annotations would not cause an event to be triggered when using Instant. (#1690)
• Fixed
  Fixes an issue with the ViewState API which allowed to change InteractionMode when the document was in read only mode. (#1838)
• Fixed
  Fixes an issue where the text of a TextAnnotation in the generated PDF was cut off. (#1275)
• Fixed
  Fixes a race condition when trying to use Instange#getAnnotations for a page that is loading its annotations. (#1871)

Instant

• Added
  Adds annotation name to Instant JSON. Also renamed pspdfkit/file name to filename to prevent collisions. (#C14856)
• Added
  Adds isFitting to text annotations in Instant JSON. This property is used to correctly display the annotation in environments where the annotation's font is not available. (#977)

Example

• Added
  Adds support for simple layer authentication to the Node.js example app. (#1817)
• Changed
  Improves experience for Windows users for all example applications. (#1857)
• Changed
  Update React and Webpack example apps to work with the new pspdfkit-lib asset directory. (#1826)
• Fixed
  Fixes an issue with the wrong mime types in the React example app. (#1825)

2018.2.2 – 16 Nov 2018

UI

• Fixed
  Fixes broken PDF text parsing in Firefox, Edge, and IE 11. (#2473)

2018.2.1 – 2 May 2018

UI

• Fixed
  Fixes an issue with responsive toolbar groups including items from other groups. (#1784)
• Fixed
  Fixes missing translation in search UI. (#1791)

Model

• Fixed
  Fixes an issue where forms where not properly loaded when starting in read only mode. (#1794)

2018.2 – 28 Mar 2018

See the announcement post.

UI

• API
  Adds Configuration#disableTextSelection to disable text selection and Configuration#disableHighQualityPrinting to disable high quality printing. (#1424)
• API
  Adds Instance#getTextSelection() and a new event textSelection.change to access the text selection state. (#1724)
• API
  Adds page.onPress and textLine.onPress events to control clicks in the document. (#1724)
• API
  Adds Instance#jumpToRect() to make sure a specific rect (in PDF page coordinates) is brought into the viewport. (#1750)
• API
  Adds ability to create and add custom overlay items to the document. (#1709)

  • API
    Adds Instance#setCustomOverlayItem() to create and update a custom overlay item.
  • API
    Adds Instance#removeCustomOverlayItem() to remove a custom overlay item.
  • API
    Adds PSPDFKit.CustomOverlayItem - a record to create custom overlay items.
• API
  Adds I18n (internationalization) support. (#1732)

  • API
    Adds PSPDFKit.I18n to access and modify internationalization data. (#1732)
  • API
    Adds Instance#locale and Instance#setLocale to manage the application locale. (#1732)
• API
  Adds support for customizing the search behavior. (#1739)

  • API
    Adds Instance#searchState, Instance#setSearchState(), and PSPDFKit.SearchState to control the state of the search UI.
  • API
    Adds Instance#startUISearch() as a shortcut to show the search box, type in a search term, and start the default search behavior.
  • API
    Adds new search events: search.stateChange will be fired whenever PSPDFKit.SearchState updates, search.termChange will be fired whenever the user changes the search term.
• API
  Adds Instance#getSelectedAnnotation(), Instance#setSelectedAnnotation(), and the event annotationSelection.change to interact with the currently selected annotation. (#1562)
• Added
  Adds PSPDFKit for Electron. (#1758)
• Added
  Adds I18n (internationalization) support. (#1732)
• Added
  Adds a customizable confirm dialog instead of using confirm(). (#1670)
• Added
  Adds support for iOS 11.3. (#1746)
• Changed
  Improves rendering performance on low resolution and mobile devices. (#1727)
• Changed
  Changes the breakpoint for showing note annotation contents in full screen. (#1783)
• Fixed
  Fixes ToolbarItems with not unique IDs render multiple times on resize. (#1728)
• Fixed
  Fixes an issue with an invalid cursor for the pan tool on Internet Explorer 11. (#1777)
• Fixed
  Fixes an issue where the wrong toolbar items where shown quickly after closing the native print dialog. (#1734)
• Fixed
  Fixes an issue with the layout of slider inputs on Microsoft Edge and Internet Explorer 11. (#1775)
• Fixed
  Fixes a rendering issue when using standalone deployments and rotated pages on WebKit. (#1778)

Model

• Added
  Adds support for parsing GoToEmbeddedAction, GoToRemoteAction, HideAction, JavaScriptAction, LaunchAction, and NamedAction. (#1736)
• Added
  Adds Instance#setAnnotationCreatorName() to set the annotation creator name and Annotation#creatorName , Annotation#createdAt, and Annotation#updatedAt to an annotation. (#1714)
• Added
  Adds Instance#search() to find occurrences of a text string in the raw PDF. (#1739)
• Added
  Adds PSPDFKit.SearchResult to describe a search result. (#1739)
• Added
  Adds Instance#renderPageAsArrayBuffer to render a page as an ArrayBuffer. (#1431)
• Added
  Adds Instance#renderPageAsImageURL to render a page and get a URL to it. (#1431)
• Added
  Adds Instance#getMarkupAnnotationText to extract the text from markup annotations. (#1705)
• Added
  Adds validation for annotations created and/or updated via public API. (#1731)
• Changed
  Improves Instance#getAnnotations to throw an error, when called with invalid arguments. (#1781)
• Fixed
  Fixes an issue in our WASM regression detection for iOS 11.2.6. (#1745)
• Fixed
  Fixes an issue with exportXFDF not preserving the document state. (#1768)
• Removed
  Deprecates Instance#renderCover. (#1431)

Example

• Added
  Adds the new PSPDFKit for Electron example. (#1758)

Instant

• Added
  Adds createdAt, updatedAt and creatorName to Instant JSON. (#C14443)

2018.1.5 – 16 Nov 2018

• Fixed
  Fixes broken PDF text parsing in Firefox, Edge, and IE 11. (#2473)

2018.1.4 – 15 Mar 2018

No web-specific changes in this version.

2018.1.3 – 8 Mar 2018

• Fixed
  Fixes an issue where the wrong toolbar items where shown quickly after closing the native print dialog. (#1734)
• Fixed
  Fixes an issue in our WASM regression detection for iOS 11.2.6. (#1745)

2018.1.2 – 28 Feb 2018

• Added
  Adds support for automatically extracting links from text. (#C13944)
• Changed
  Significantly reduces the memory usage for Standalone deployments. (#1453)
• Fixed
  Fixes clients presence connections failures that were not handled. (#1723)

2018.1.1 – 14 Feb 2018

• Fixed
  Fixes sidebar button not selected when the sidebar is open. (#1712)

2018.1 – 8 Feb 2018

See the announcement post.

• API
  Adds support for rotating pages in the current view. (#1621)

  • API
    Adds ViewState#pagesRotation to set the currently applied rotation.
  • API
    Adds ViewState#rotateLeft() and ViewState#rotateRight() to rotate the current view by 90° clockwise or counterclockwise.
• API
  Adds a new toolbar item sidebar-thumbnails. (#1614)
• API
  Adds ViewState#sidebarMode to control the sidebar. (#1614)
• Added
  Adds support for rotating pages. (#1621)
• Added
  Adds support for importing and exporting XFDF. (#1651)
• Added
  Adds support for exporting Instant JSON on server setups. (#1662)
• Added
  Adds support for grouped checkbox form fields. (#1689)
• Added
  Adds WASM streaming initialization and caching for supported browsers. (#1644)
• Added
  Adds more runtime type checks to the ViewState API. (#1655)
• Added
  Adds sidebar for page thumbnails previews. (#1614)
• Added
  Adds keyboard shortcuts to change page using the left and right arrow keys. (#1666)
• Added
  Adds support for the NoView flag for all supported annotations. (#1683)
• Fixed
  Fixes a WASM regression on iOS 11.2.2 and 11.2.5 by disabling WASM support on these particular versions. (#1650)
• Fixed
  Fixes a bug where opening the layout-config menu will hide new ink drawings. (#1652)
• Fixed
  Fixes an issue where unchecked checkboxes were not properly exported. (#1673)
• Fixed
  Fixes a bug where pages were briefly rendered in the browser while printing. (#1678)
• Fixed
  Fixes keyboard shortcuts work in combination with shift key. (#1696)

2017.9.4 – 24 Jan 2018

No web-specific changes in this version.

2017.9.3 – 17 Jan 2018

• Fixed
  Fixes an issue when opening a PDF using the RESTProvider and a license without forms. (#1612)
• Fixed
  Fixes an issue when deleting an annotation using the RESTProvider. (#1635)
• Fixed
  Fixes a bug preventing client presences to be updated. (#1618)
• Fixed
  Fixes full screen keyboard shortcut instead open search. (#1609)
• Fixed
  Fixes incorrect text lines in some documents. (#C13148)
• Fixed
  Fixes an assertion when a non-specified named action was deserialized via Instant JSON. (#C13804)
• Fixed
  Fixes PrintMode.EXPORT_PDF not working in Edge and IE 11 for Standalone deployments. (#1640)

2017.9.2 – 20 Dec 2017

• Fixed
  Fixes permission compatibility with server. (#1601)
• Fixed
  Fixes setFormFieldValue sending malformed payload to the server. (#1599)

2017.9.1 – 15 Dec 2017

• Fixed
  Fixes an issue where trial licenses did not have the form license flag set. (#C13553)

2017.9 – 14 Dec 2017

See the announcement post.

• API
  Adds support for programmatic form filling. (#936)

  • API
    Adds Instance#getFormFields() to access form fields.
  • API
    Adds Instance#getFormFieldsValues() and Instance#setFormFieldsValues() to easily access the current form field values.
  • API
    Adds WidgetAnnotation to the annotation API. This annotation can never be modified and is used to render form fields.
  • API
    Adds SubmitFormAction and ResetFormAction. The submit action will also fire forms.willSubmit and forms.didSubmit, respectively.
• API
  Adds a new toolbar item type, responsive-group. This can be used to create groups of toolbar items for smaller screens. (#1412)
• Added
  Adds support for interactive forms. (#936)
• Added
  Adds support for filling forms via Instant. (#936)
• Added
  Adds a responsive mode to the toolbar. Annotation tools are now by default grouped under an “Annotate” option on small screens. (#1412)
• Added
  Adds headless mode to run PSPDFKit for Web without a user interface. (#1534)
• Fixed
  Fixes an error in Instant when two clients edit text annotations simultaneously. (#1522)
• Fixed
  Fixes flickering of the note annotation popover when a note annotation is selected. (#1363)
• Fixed
  Fixes an issue where default colors for highlight annotations were not rendered properly. (#C12938)

2017.8.1 – 6 Dec 2017

No web-specific changes in this version.

2017.8 – 22 Nov 2017

• Changed
  Changes annotation IDs from numerical to client-side generated string IDs. (#1303)
• Fixed
  Fixes a bug that prevented text selection starting from non-text nodes. (#1492)
• Fixed
  Fixes impossible to deselect text. (#1492)
• Fixed
  Fixes canceled text lines requests in standalone resolve anyway. (#1506)
• Fixed
  Fixes an issue with Instant on documents without the edit-annotations permission. (#1451)

2017.7.1 – 15 Nov 2017

• Changed
  Improved memory management for standalone deployments. (#1453)
• Fixed
  Fixes getBaseUrl removes part of the url in IE. (#1456)
• Fixed
  Fixes copied text includes new lines in Firefox and IE. (#1463)

2017.7 – 25 Oct 2017

See the announcement post.

• API
  Adds PSPDFKit.unload to terminate running and loading instances in favor of the now deprecated Instance#destroy. (#1389)
• API
  Adds new CSS classes to select annotations. (#1414)
• API
  Adds new CSS class to select text. (#1406)
• API
  Adds option to specify a pageIndex to the Instance#renderCover standalone API. (#1404)
• API
  Adds option to disable WebAssembly when using standalone deployments. (#1416)
• API
  Adds new contentWindow and contentDocument getters to the Instance to quickly access the content of the PSPDFKit viewer. (#1439)
• API
  Adds API for printing and introduces printing modes. (#1319)
• API
  Fixes the casing in CSS class names of specific note annotation icons to be more consistent. (#1414)
• Added
  Adds new printing mode DOM. This method will render all pages of the PDF document in advance before it sends the results to the printer. (#1319)
• Added
  Adds a new icon set for all toolbar items. (#1413)
• Added
  Adds pinching for touch devices in PER_SPREAD scroll mode. (#1315)
• Changed
  Improved support for Apple Pencil. (#1415)
• Changed
  Improved WebAssembly/asm.js loading time of subsequent initializations. (#1390)
• Fixed
  Fixes an issue where an Instant sync conflict was causing an invalid state. (#1347)
• Fixed
  Fixes an issue with the transition of note annotation popovers. (#1388)
• Fixed
  Fixes an issue that sometimes prevented the text caret to be drawn in IE 11 and Edge. (#1395)
• Fixed
  Fixes the position of the initial text caret on Safari. (#1396)
• Fixed
  Fixes a rendering issue that resulted into a blurry pages when using standalone deployments. (#1261)
• Fixed
  Fixes the spacing of color picker items in responsive mode. (#1414)
• Fixed
  Fixes an issue that emitted the wrong payload with the annotations.delete event. (#1423)
• Fixed
  Fixes an issue that caused a crash when the page index of an annotation was out of bounds. (#1397)
• Fixed
  Fixes an issue that prevent toolbar items from being disabled via the API. (#1432)

2017.6.1 – 2 Oct 2017

• Added
  Adds support for Internet Explorer 11 when using standalone deployments. (#C11782)
• Changed
  Improves read-only mode for note annotations. (#1360)
• Changed
  Improves error messages when invalid JWT token is supplied. (#1379)
• Changed
  Changes the default breakpoint for the layout-config toolbar item. (#1364)

2017.6 – 18 Sept 2017

See the announcement post.

• API
  ViewState#pageSpacing is now used for the spacing between pages in LayoutMode.DOUBLE. For the previous behavior, please use ViewState#spreadSpacing instead.
• API
  Deprecates ViewState#viewMode and adds ViewState#layoutMode and ViewState#scrollMode. (#1272)
• API
  Renames ZoomMode.PAGE_FIT and ZoomMode.PAGE_WIDTH to ZoomMode.FIT_TO_VIEWPORT and ZoomMode.FIT_TO_WIDTH. (#1277)
• API
  Adds ViewState#keepFirstSpreadAsSinglePage to start with a single page in LayoutMode.DOUBLE. (#737)
• API
  Adds Instance#textLinesForPageIndex to extract text content of a page. (#1302)
• Added
  Adds double page mode for both scroll modes. (#737)
• Added
  Adds support for zooming and scrolling in PER_SPREAD scroll mode. (#1285)
• Added
  Adds pagination by using the mouse scroll wheel in PER_SPREAD scroll mode. (#1285)
• Added
  Adds support for Note annotations. (#1235)
• Changed
  Improves error messages for some APIs. (#1304)
• Changed
  Improves performance when opening a big PDF with many annotations. (#1304)
• Changed
  Improves user experience while rendering pages. (#1301)
• Fixed
  Fixes an issue where annotations imported via Instant JSON could no longer be updated or deleted. (#1312)
• Fixed
  Fixes an issue where the zoom level was not properly recalculated, when the viewport dimensions changed. (#1310)
• Fixed
  Fixes an issue with printing still working after being disabled via API. (#1324)
• Fixed
  Fixes an issue where an error was logged when refreshing the browser. (#1329)
• Fixed
  Fixes errors that ocurred when the root element was removed from the DOM, before the viewer finished loading. (#1328)
• Fixed
  Fixes a race condition that could occur when syncing annotations. (#1343)

2017.5.4 – 31 Aug 2017

No web-specific changes in this version.

2017.5.3 – 17 Aug 2017

• Fixed
  Fixes an issue with Chrome that prevented the document from rendering in certain environments. (#1293)

2017.5.2 – 9 Aug 2017

• Changed
  Improves backoff behavior of Instant endpoint when an error occurs. (#1249)
• Fixed
  Fixes an issue where zooming in or out when text is selected caused a wrong popover position. (#1269)
• Fixed
  Fixes Safari/IE 11 not including request headers for tiles request. (#1283)
• Fixed
  Fixes exportPDF flattens by default converting annotations to non-editable content. We made it configurable. (#1276)
• Fixed
  Fixes an issue where a floating point font size for a text annotation causes two options with the same value in the dropdown list. (#1284)

2017.5.1 – 24 Jul 2017

• Changed
  Improves standalone rendering speed. (#1243)
• Changed
  Improves error logging in some cases. (#1251)
• Fixed
  Fixes the default save mode when using standalone deployments. (#1257)
• Fixed
  Fixes an issue with Edge when using standalone deployments. (#1250)

2017.5 – 20 Jul 2017

See the announcement post.

• API
  Adds Configuration#pdf to load a PDF for client side rendering via an URI or an ArrayBuffer. (#966)
• API
  Adds ability to create, read, update, and delete annotations as well as an API to observe annotation changes. (#937)
• API
  Adds event before and after the annotations are saved. (#1150)
• API
  Expose annotation interfaces (Annotation, HighlightAnnotation, InkAnnotation, LinkAnnotation, SquiggleAnnotation, StrikeOutAnnotation, TextAnnotation, MarkupAnnotation UnderlineAnnotation, UnknownAnnotation). (#1049)
• API
  Exposes new primitives types (Immutable.List, Geometry.Point, Geometry.DrawingPoint, Geometry.Rect, Geometry.Size and Color). (#1031)
• API
  Exposes PDF action types (Actions.GoToAction, Actions.URIAction). (#1037)
• API
  Supports different save modes and adds ability to save annotations manually. (#964)
• API
  Renames viewstatechanged, currentpageindexchanged, zoomchanged and connectedclientschanged events. (#1151)
• API
  Adds Instance#hasUnsavedAnnotations to find out if unsaved annotations are present. (#1152)
• API
  Adds Instance#exportPDF to access the raw PDF binary data as ArrayBuffer. (#1163)
• API
  Adds Instance#exportInstantJSON and Configuration#instantJSON to serialize and deserialize the document state including all annotations using Instant JSON when no server is present. (#1158)
• API
  Adds Instance#renderCover to render the first page as a thumbnail for client side rendering. (#1178)
• API
  Allow to override onPress handlers for annotations. (#1175)
• API
  Allow to overwrite the inferred base url for the Server in case the JavaScript is loaded from a different host. (#1185)
• Added
  Adds support for client side rendering using WebAssembly (wasm) or asm.js. Please visit our guides for more information. (#966)
• Added
  Adds support for bundling PSPDFKit for Web using an npm package. (#1098)
• Changed
  Improves pinching performance on mobile devices. (#1085)
• Changed
  Improves performance of tile rendering. (#1125)
• Fixed
  Fixes zoom buttons should only be hidden for touch devices. (#1077)
• Fixed
  Fixes error in the Custom Toolbar when mediaQueries is set to undefined. (#1080)
• Fixed
  Fixes cleanup of event listeners when drawing ink annotations. (#1061)
• Fixed
  Fixes a bug that caused Safari on iOS to trigger the default zoom behavior on double tap. (#859)
• Fixed
  Fixes an issue with babel-polyfill. (#1108)
• Fixed
  Fixes issue when quickly jumping through search results. (#1078)
• Fixed
  Fixes prevent text annotation to increase page size when created at the edge. (#1130)
• Fixed
  Fixes sliders' thumb position for Edge. (#1136)
• Fixed
  Fixes sliders' vertical alignment in IE 11. (#1136)
• Fixed
  Fixes an issue where the initial viewport size was wrong. (#1240)
• Fixed
  Fixes link annotations not clickable when in read-only mode. (#1242)

2017.4 – 16 May 2017

See the announcement post.

• API
  Adds ability to customize and add new items to the main toolbar. (#1048)
• API
  Adds new option interactionMode to ViewState to enable ink, text, search and pan mode. (#1003)
• API
  Adds version to PSPDFKit to get the current version of PSPDFKit for Web. (#1047)
• Added
  Adds support for interacting with all annotation types (ink, text, highlight, squiggle, underline, strike-through, and link) on mobile devices. (#906)
• Added
  Adds a special annotation toolbar that appears when text is selected to allow the creation of markup annotations on mobile devices. (#1060)
• Added
  Adds pan tool to allow users to navigate on a desktop browser using mouse dragging. (#887)
• Changed
  Improves the scrolling performance in Chrome browsers when an ink annotation is inside the viewport. (#616)
• Changed
  Improves tiling by avoiding unnecessary calculations. (#1000)
• Changed
  Improves ink annotation creation on different pages. (#985)
• Changed
  Improves logging and descriptiveness of messages for errors in HTTP APIs. (#S1078, #S1110)
• Fixed
  Fixes issues with empty text annotations. (#821)
• Fixed
  Fixes an issue with text annotations that get dragged while they're changed. (#980)
• Fixed
  Fixes a bug that prevented the focus of the text annotation after clicking on it. (#1013)
• Fixed
  Fixes a bug that caused a wrong initial text selection within a text annotation. (#929)
• Fixed
  Fixes a bug that caused an exception when destroying the PSPDFKit for Web instance on IE 11. (#1034)
• Fixed
  Fixes the centering of the content inside the viewport. (#998)
• Fixed
  Fixes a bug where delete annotation can delete pdf assets. (#S1117)

2017.3.2 – 19 Apr 2017

• Added
  Adds CSS class for unsupported annotations and hides them by default. (#991)
• Fixed
  Fixes a bug where the user_id of the user performing a change was not always persisted. (#S1083)

2017.3.1 – 12 Apr 2017

• Added
  Adds a new license information page to the dashboard. (#S1074)
• Added
  Adds cmd+g and cmd+shift+g keyboard shortcuts to jump to the next/previous search result (macOS only). (#961)
• Changed
  load() will now throw if the container element has children. (#957)
• Fixed
  Fixes buggy behavior in Firefox where the user needs to press backspace twice to start to delete from the end of a text annotation. (#974)
• Fixed
  Fixes a bug in Firefox where a NO-BREAK SPACE was inserted after the first line break. (#976)
• Fixed
  Fixes a bug when switching annotation modes. (#818)

2017.3 – 29 Mar 2017

See the announcement post.

• API
  Adds option to enable read only mode. (#886)
• API
  Adds option to hide annotations. (#886)
• API
  Custom style sheets must now be set through the JavaScript API. (#630)
• API
  Adds option to hide the print icon to ViewState. (#845)
• API
  Adds many new public CSS classes. (#733)
• API
  Adds documentation for load(). (#839)
• Added
  Adds support for printing documents. (#845)
• Added
  Adds new AUTO zoom mode for a better default experience. (#741)
• Added
  Adds support for flattening annotations into the PDF before it is downloaded. (#S1026)
• Added
  Adds support for permissions to selectively enable/disable viewing and editing features. These replace the old access control based on the access and user_id fields. (#S1031)
• Changed
  Prevents CSS conflicts by encapsulating the viewer. (#630)
• Changed
  Enforces document_id to be type of string in the JWT. (#824)
• Changed
  Updates the format of the JWT used for authentication. (#S1031, #S1043)
• Removed
  Removes border of link annotations. (#882)
• Fixed
  Fixes an error for Chrome >= 56 that was caused by Chrome making event handlers passive per default. (#792)
• Fixed
  Fixes z-index ordering for some annotations to prioritize newer ones. (#746)
• Fixed
  Fixes an issue that prevented dragging annotations in IE 11. (#870)
• Fixed
  Fixes an issue with editing a text annotation after reloading. (#852)

2017.2 – 17 Feb 2017

See the announcement post.

• API
  The server will now always return and expect string document IDs. (#808)
• Added
  Adds HTTP API for working with annotations.
• Added
  Adds a debug mode to track down issues during development. (#760)
• Added
  Adds shortcuts to zoom in, out and back to page-fit.
• Changed
  Shows toolbar when starting to create an ink or text annotation. (#801)
• Changed
  Improves read-only mode. (#761)
• Changed
  Improves the contrast of resize anchors. (#751)
• Changed
  Improves the Dashboard experience.
• Changed
  Search now also appears via CMD-G on macOS. (#758)
• Fixed
  Fixes an issue that sends an invalid search request. (#756)
• Fixed
  Fixes an issue where parts of the annotation toolbar disappeared. (#647)
• Fixed
  Fixes an issue with hidden toolbar buttons. (#794)

2017.1 – 25 Jan 2017

See the announcement post.

• Added
  Adds search. (#722)
• Added
  Adds custom dropdown to preview fonts. (#413)
• Changed
  Optimizes ink annotations. (#590)

2016.3 – 21 Dec 2016

See the announcement post.

• Added
  Adds a dashboard for easy control over the server.
• Changed
  Shows a font's name in the dropdown even if the font is not available. (#665)

2016.2.1 – 12 Dec 2016

• Fixed
  Fixes an issue with external events. (#699)

2016.2 – 8 Dec 2016

• Added
  Adds support for Internet Explorer 11. (#676)
• Removed
  Removes white space after the last page on Firefox for Android. (#651, #652)
• Fixed
  Fixes an issue with text annotation clipping on Edge. (#644)
• Fixed
  Fixes an issue with PDF documents that have fractional page dimensions. (#660)
• Fixed
  Fixes an issue with the AnnotationToolbar position. (#661)

2016.1 – 1 Dec 2016

See the announcement post.

• Changed
  First public release.