This month has seen the public launch of XD panel APIs for developers. We’ve had a lot to communicate leading up to the forthcoming launch of panel plugins in the XD Plugin Manager.
We want to make this next step as easy to follow as possible, so I’m pulling together various topics in this thread that will be important to anyone working on panels this month. We’ll revise and add as needed.
Below, you’ll find critical information on these topics:
- Test on the release version of XD 21.1
- Known API bugs to avoid in panels
- Designing panels for XD’s minimum width
- Plugin IDs and migrating existing plugins to panels
- Notes on the review process for panels
Test on the release version of XD 21.1
XD 21.1, a patch update, was just released today. If you are building panel-based plugins, please prioritize testing on this build.
Not recommended for panels testing at this point:
- Prerelease builds
- XD 20.0.##
Known API bugs to avoid in panels
application.editDocument() not being enforced yet
application.editDocument() method must wrap any action that a panel takes to modify the XD document.
There is a bug in XD 21.0.## where this rule is not strictly enforced, thereby letting panels make modifications that should not be allowed. This bug is fixed in today’s XD 21.1.## release. Any plugin not using
editDocument() correctly will break.
The good news here is that if you’re already doing the right thing, you’ll be fine. ☆
position: fixed is broken for panels
In your CSS,
position: "fixed" should not be used in production panel-based plugins (modals are not affected). There is a known issue where the coordinate system is respective to the entire panel rather than the plugin container. This will be addressed in a future XD release, which will break the layout of any plugins using
For now, we will not approve any panel plugins found using
position: “fixed” until the issue is fixed on our side.
Designing panels for XD’s minimum width
Please design for the minimum width of XD’s UI. Several beta plugins we’ve tested have had UI elements that are lost if the user has their Adobe XD window smaller than the screen size. When the XD window is smaller, the plugin UI real estate can also become smaller.
These are the minimum widths you’ll need to design for:
- macOS minimum size: 194 px with 12 px margins
- Windows minimum size: 240 px with 16 px margins
This information and more will be officially documented in the near future.
Plugin IDs and migrating existing plugins to panels
Notes on the review process for panels
We’ll start seeing panel plugins become available in the XD Plugin Manager soon.
If you’re working directly with anyone at Adobe on the timeline for shipping your plugin, please coordinate with them directly about the right time to submit to the review process.
If you’re developing independently and have already submitted to the review process, please note that the publishing timeline will take a bit longer than usual given the excitement around this launch.
Please bear with us; like you, we are super excited to get panel plugins through the process and into the hands of users!