2020.6 Migration Guide

PSPDFKit for Web 2020.6 comes with a few improvements that might require an ad hoc migration.

Notable Changes

  • This release introduces a new blue color: rgb(34, 147, 251). This new blue color will be used in the color picker instead of the old one, and it’ll be used as the default ink color (it affects ink annotations and shape annotations like rectangle and ellipse annotations, both of which are configurable).

    If you wish to see the old blue color in the color picker, you can amend the PSPDFKit.Options.COLOR_PRESETS object before PSPDFKit.load():

    Copy
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    
    const blue = {
      color: new PSPDFKit.Color({ r: 36, g: 131, b: 199 }),
      localization: {
        id: "customBlue",
        defaultMessage: "Custom blue",
        description: "custom blue"
      }
    };
    PSPDFKit.Options.COLOR_PRESETS = PSPDFKit.Options.COLOR_PRESETS.concat([
      blue
    ]);
    

    And here’s how to configure the old blue as the default ink color using the annotation presets:

    Copy
    1
    2
    3
    4
    5
    6
    7
    
    const annotationPresets = PSPDFKit.defaultAnnotationPresets
    annotationPresets.ink = {
      ...annotationPresets.ink,
      strokeColor: PSPDFKit.Color.DARK_BLUE,
    }
    
    PSPDFKit.load({annotationPreset, ...})
    
  • This release changes the way in which you can move an annotation using the UI. By default, annotations can only be moved inside page boundaries. If you want to disable this behavior and enable the previous behavior, please use the following configuration option:

    1
    2
    3
    
    PSPDFKit.load({
      restrictAnnotationToPageBounds: false
    });
    

For a full list of changes, check out the changelog.

If you use PSPDFKit Server, please make sure you read the 2020.6 Server Migration Guide.