2022-02-01 changelog

Miro Web SDK 2.0: ⚠ breaking changes! ⚠
Renamed arguments of the openModal and openPanel methods.

Summary

❗️

Breaking change

Affects:

• Miro Web SDK 2.0 openModal method
• Miro Web SDK 2.0 openPanel method

What has changed

To simplify naming, and to keep consistency across the Miro Web SDK 2.0 properties, we renamed the following arguments:

This is a breaking change that affects the openModal and the openPanel methods.
If you are using these Miro Web SDK 2.0 methods in your code, make sure you refactor them to implement the updated names for these arguments.

Examples

// openModal method using renamed arguments
await miro.board.ui.openModal({
-  pageUrl: 'example.html',
-  maxHeight: 250,
-  maxWidth: 320, 
+  url: 'example.html', 
+  height: 250,
+  width: 320,
  });

// openPanel method using renamed arguments
// Note: the panel has a fixed width of 368 px, no padding
await miro.board.ui.openPanel({
-  pageUrl: 'example.html',
-  maxWidth: 250,
+  url: 'example.html', 
+  height: 250,
  });