README.md

Adobe XD Plugin API typings

Typings for Adobe XD API Surfaces

Detailed instructions for using these type declarations to get autocompletion features in editors and IDEs can be found in the repository's wiki.

Download

The best option to download the typings is to download the latest release from https://github.com/AdobeXD/typings/releases.

Getting started

These Type Declaration files provide your IDE (e.g. Visual Studio Code or WebStorm) with information about the XD API surface, enabling type checking, autocomplete suggestions, and more. To get started, simply copy the following resources from this repo into your project's main directory:

• The jsconfig.json file.
• The types directory.

Your IDE may require further setup to take full advantage of the types. Please see this wiki page for more.

The Type Declaration files also allow you to use TypeScript instead of JavaScript for your plugin development. For that, you'll have to copy the types folder to your project and include it in the paths of your tsconfig.json:

{
  "paths": {
    "*": [
      "types/*"
    ]
  }
}

You may also take a look at the tsconfig.json file contained in this repository for reference.

One last thing

These type declarations track the contents of the official documentation. If an issue with the type declarations stems from an issue with the official documentation, then the type declaration files will be fixed once the issue is addressed in the documentation. This is intentional so as to keep the type declarations both maintainable and in sync with the documentation.

A few notable exceptions include:

• scenegraph.SceneNode and scenegraph.RootNode, are documented as classes, but implemented as interfaces (in the TypeScript-sense, i.e., without a constructor), which is how they get declared in the typings
• To avoid ambiguity with the DOM Selection type, the interface Selection is implemented under the name XDSelection (in the global namespace), here.
• The LinearGradient type is incorrectly documented as LinearGradientFill. This is implemented "the right way" in the typings.