v1.20.0 Changelog

Breaking Changes

• Editor: The distributed file for the CE.SDK (@cesdk/cesdk-js package on npm) has changed from the CommonJS to the ECMAScript Module format. This means:

  • If you’ve been using the CE.SDK from your own node_modules folder in combination with a bundler, nothing should change for you. The bundler will process the module as before.

  • If you were loading our CDN version directly into your web page, and then accessing the CreativeEditorSDK global variable, we instead recommend to either change your script to ECMAScript module, or use the import() function to load the CreativeEditorSDK:

    <script type="module">
      import CreativeEditorSDK from 'https://cdn.img.ly/packages/imgly/cesdk-js/1.19.0/index.js';
    
      await CreativeEditorSDK.create('#container');
      // ...your code
    </script>

    <script>
      import('https://cdn.img.ly/packages/imgly/cesdk-js/1.19.0/index.js').then(
        async ({ default: CreativeEditorSDK }) => {
          await CreativeEditorSDK.create('#container');
          // ...your code
        }
      );
    </script>

• Engine: Fixed visual glitches in the following effects: “Pixelize”, “Radial Pixel”, and “Dot Pattern”

• Engine: We’ve added a new feature called sourceSet to image fills. This lets you use a group of images, each with different sizes, to draw the image. The engine will pick the best size and load it as needed. You can learn more about this in the guide. Remember, if you have a fileImageURI, the sourceSet will take precedence. If your code changes the imageFileURI, you need to update it to work with the sourceSet as well.

• Editor: We’ve updated our Unsplash and Demo sources. They now come with a full set of images in different sizes. This means that any block you create using an image from these sources will automatically have its sourceSet property populated.

Non Breaking Changes

• Engine: Exported TGA images now include an alpha channel.
• Editor: Assets from the asset library can now be dragged on the canvas to apply the asset
• Editor/Web: Fix potentially corrupted video export.
• Editor: Added new settings to configure how the page title is displayed, see documentation.
• Editor: Adds setPanelPosition to the UserInterface API
• Editor: Adds setPanelFloating to the UserInterface API
• Editor: Adds options to openPanel to override position and floating settings
• Editor: CanvasMenu component border color uses token --ubq-border-default and has box shadow added.
• Editor/Engine: Using a web worker for video exports
• Engine: Added mousewheel support The CreativeEngine canvas now supports mouse wheel events on the canvas to scroll and zoom the scene. The CreativeEngine instance gained a new method, setWheelEventTarget, which can be used to reinstall the event listener on another DOM element. This can be useful for situations where custom DOM elments are positioned on top of the canvas. Two engine settings have been added to enable/disable scrolling and zooming: mouse/enableZoom and mouse/enableScroll, both default to true.
• Engine: Removed arbitrary strings for engine settings from the TypeScript definitions. Passing arbitrary strings to methods such as setSettingBool or setSettingString was never actually supported. The types have been adjusted to reflect that fact.
• Editor/Engine: The Typescript types of the getSetting/setSetting methods in the EditorAPI have been made more strict:
  • Previously, Typescript allowed arbitrary strings as keys, which would have led to an error at runtime. These have been removed.
  • Support for prefixing settings keys with ubq:// will be removed in a future version. The function signatures have been updates to provide a deprecation warning.
  • A few boolean settings not meant for public use have been removed.
• Engine: Add support XAVC videos.
• Engine/Editor: Add missing settings to the Typescript type definitions in the EditorAPI.