About our How-to guides

The following guides contain a set of common use cases and accompanying code snippets that will help you quickly implement a wide variety of features in your add-ons.

data-slots=header, text1

data-variant=info
Try samples in Code Playground!
Many how-to guides now include a "Try" button that opens the code sample directly in the Code Playground. Click the button to instantly test Document API samples in Script mode without setting up a local development environment!

We're constantly adding new how-tos, so make sure to check back often. If you're looking for Tutorials that guide you in building add-ons from the ground up, please check the Complete Projects section.

How-to guides

<br/><br/>

Topics
How-to guides
Authentication & Authorization
Use OAuth 2.0
Data & Environment
Store Data
Theme & Locale
UI & Interaction
Use Drag & Drop
Use Modal Dialogs
Document Structure
Manage Pages
Use Design Elements
Use Text
Use Geometry
Use Color
Use Images
Use Videos
Use Audio
Use PDF and PowerPoint
Handle ElementSelection
Group Elements
Position Elements
Use Metadata
Document Metadata
Page Metadata
Element Metadata
Exporting & Output
Create Renditions
Manage Premium Content
User Info
Identify users

Complete Projects

We've created a set of in-depth tutorials that guide you through the process of building a complete add-on from scratch.

<br/><br/>

Topics
Tutorials
Document APIs
Design Grid creator
Communication APIs
Stats Add-on
Adobe Spectrum Web Components
Basic JavaScript add-on with Spectrum Web Components
Lit & TypeScript
Using Lit & TypeScript

We recommend you to start with the Design Grid creator, which covers the basics of the add-on SDK and how to use the Document API.

Design Grid creator

Other resources

We've also created a collection of Code Samples that you can use to get started. You can use the SDK References to find all of the objects, methods, properties and events supported for building add-ons.