addOnUISdk.constants

A set of constants used throughout the Add-on UI SDK for type-safe development. See the Add-on UI SDK Constants Guide for practical examples and usage patterns.

Most constants support dual access (import statement OR addOnUISdk.constants.*), but four constants require an import statement: AppEvent, ColorPickerEvent, SupportedMimeTypes, and EntrypointType.

Import Quick Reference

Dual Access (Most Constants)

You can access these constants in two ways:

// Option 1: Import statement (recommended)
import { Range, RenditionFormat, Variant } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// Option 2: Constants object
addOnUISdk.constants.Range.currentPage
Copied to your clipboard
// Option 1: Import statement (recommended)
import { Range, RenditionFormat, Variant } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// Option 2: Constants object
addOnUISdk.constants.Range.currentPage

Import Required (Four Constants Only)

These four constants must be imported with an import statement and will return undefined if accessed through addOnUISdk.constants.*:

AppEvent - Events dispatched by the Add-on SDK
ColorPickerEvent - Color picker custom events
SupportedMimeTypes - MIME types for PDF conversion
EntrypointType - Add-on entry point types

import { AppEvent, ColorPickerEvent, SupportedMimeTypes, EntrypointType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
Copied to your clipboard
import { AppEvent, ColorPickerEvent, SupportedMimeTypes, EntrypointType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

Constants Reference

Complete technical specifications organized by functional category.

BitRate

import { BitRate } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.BitRate
Copied to your clipboard
import { BitRate } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.BitRate

Bit rate values in bits per second for video renditions.

Value	Description	Numeric Value
`mbps4`	4 Mbps	`4000000`
`mbps8`	8 Mbps	`8000000`
`mbps10`	10 Mbps	`10000000`
`mbps12`	12 Mbps	`12000000`
`mbps15`	15 Mbps	`15000000`
`mbps25`	25 Mbps	`25000000`
`mbps50`	50 Mbps	`50000000`

BleedUnit

import { BleedUnit } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.BleedUnit
Copied to your clipboard
import { BleedUnit } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.BleedUnit

Units for page bleed measurements.

Value	Description
`in`	Inch units
`mm`	Millimeter units

ButtonType

import { ButtonType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.ButtonType
Copied to your clipboard
import { ButtonType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.ButtonType

Types of buttons that can be pressed in modal dialogs.

Value	Description
`primary`	Primary button pressed
`secondary`	Secondary button pressed
`cancel`	Cancel button pressed
`close`	Dialog closed via ESC or close(X) button

AppEvent

import { AppEvent } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// ⚠️ Named export only - NOT available in addOnUISdk.constants
Copied to your clipboard
import { AppEvent } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// ⚠️ Named export only - NOT available in addOnUISdk.constants

Events dispatched by the Add-on SDK.

Value	Event String	Description
`themechange`	`"themechange"`	Theme changed
`localechange`	`"localechange"`	Locale changed
`formatchange`	`"formatchange"`	Format changed
`reset`	`"reset"`	Add-on reset
`dragstart`	`"dragstart"`	Drag operation started
`dragend`	`"dragend"`	Drag operation ended
`dragcancel`	`"dragcancel"`	Drag operation cancelled
`documentIdAvailable`	`"documentIdAvailable"`	Document ID available
`documentLinkAvailable`	`"documentLinkAvailable"`	Document link available
`documentPublishedLinkAvailable`	`"documentPublishedLinkAvailable"`	Published link available
`documentTitleChange`	`"documentTitleChange"`	Document title changed
`documentExportAllowedChange`	`"documentExportAllowedChange"`	Export permission changed

AuthorizationStatus

import { AuthorizationStatus } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.AuthorizationStatus
Copied to your clipboard
import { AuthorizationStatus } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.AuthorizationStatus

OAuth authorization status values.

Value	Description
`authorized`	Authorization successful
`cancelled`	Authorization cancelled by user
`error`	Authorization error occurred

ColorPickerEvent

import { ColorPickerEvent } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// ⚠️ Named export only - NOT available in addOnUISdk.constants
Copied to your clipboard
import { ColorPickerEvent } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// ⚠️ Named export only - NOT available in addOnUISdk.constants

Custom events dispatched by the Color Picker component.

Value	Event String	Description
`colorChange`	`"colorpicker-color-change"`	Color selection changed
`close`	`"colorpicker-close"`	Color picker closed

ColorPickerPlacement

import { ColorPickerPlacement } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.ColorPickerPlacement
Copied to your clipboard
import { ColorPickerPlacement } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.ColorPickerPlacement

Placement options for the color picker popover relative to anchor element.

Value	Description
`top`	Position above anchor
`bottom`	Position below anchor
`left`	Position to the left of anchor
`right`	Position to the right of anchor

DeviceClass

import { DeviceClass } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.DeviceClass
Copied to your clipboard
import { DeviceClass } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.DeviceClass

Device form factors where the add-on is running.

Value	Description
`mobile`	Mobile phone
`tablet`	Tablet device
`desktop`	Desktop computer

DialogResultType

import { DialogResultType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.DialogResultType
Copied to your clipboard
import { DialogResultType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.DialogResultType

Types of modal dialog results.

Value	Description
`alert`	Alert dialog result (simple dialogs)
`input`	Input dialog result
`custom`	Custom dialog result

EditorPanel

import { EditorPanel } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.EditorPanel
Copied to your clipboard
import { EditorPanel } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.EditorPanel

Adobe Express Editor panels that can be opened programmatically.

Value	Description
`search`	Editor Search panel
`yourStuff`	Editor Your stuff panel
`templates`	Editor Templates panel
`media`	Editor Media panel
`text`	Editor Text panel
`elements`	Editor Elements panel
`grids`	Editor Grids panel
`brands`	Editor Brands panel
`addOns`	Editor Add-ons panel

ElementsTabs

import { ElementsTabs } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.ElementsTabs
Copied to your clipboard
import { ElementsTabs } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.ElementsTabs

Tabs within the Editor's Elements panel.

Value	Description
`designAssets`	Design assets tab
`backgrounds`	Backgrounds tab
`shapes`	Shapes tab
`stockIcons`	Icons tab
`charts`	Charts tab

EntrypointType

import { EntrypointType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// ⚠️ Named export only - NOT available in addOnUISdk.constants
Copied to your clipboard
import { EntrypointType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// ⚠️ Named export only - NOT available in addOnUISdk.constants

Types of add-on entry points (currently only panel is supported).

Value	Description
`panel`	Panel entry point

FieldType

import { FieldType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.FieldType
Copied to your clipboard
import { FieldType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.FieldType

Input field types supported in Simple Dialog.

Value	Description
`text`	Text input field

FileSizeLimitUnit

import { FileSizeLimitUnit } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.FileSizeLimitUnit
Copied to your clipboard
import { FileSizeLimitUnit } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.FileSizeLimitUnit

Units for file size limits.

Value	Description
`KB`	Kilobytes
`MB`	Megabytes

FrameRate

import { FrameRate } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.FrameRate
Copied to your clipboard
import { FrameRate } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.FrameRate

Frame rate values in frames per second for video renditions.

Value	Description	Numeric Value
`fps23_976`	23.976 fps	`23.976`
`fps24`	24 fps	`24`
`fps25`	25 fps	`25`
`fps29_97`	29.97 fps	`29.97`
`fps30`	30 fps	`30`
`fps60`	60 fps	`60`

LinkOptions

import { LinkOptions } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.LinkOptions
Copied to your clipboard
import { LinkOptions } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.LinkOptions

Types of document links that can be generated.

Value	Description
`document`	Link to the current document
`published`	Link to the published document

MediaTabs

import { MediaTabs } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.MediaTabs
Copied to your clipboard
import { MediaTabs } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.MediaTabs

Tabs within the Editor's Media panel.

Value	Description
`video`	Video tab
`audio`	Audio tab
`photos`	Photos tab

PanelActionType

import { PanelActionType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.PanelActionType
Copied to your clipboard
import { PanelActionType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.PanelActionType

Types of actions that can be performed on Editor panels.

Value	Description
`search`	Perform search within the Editor panel
`navigate`	Perform navigation within the Editor panel

PlatformEnvironment

import { PlatformEnvironment } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.PlatformEnvironment
Copied to your clipboard
import { PlatformEnvironment } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.PlatformEnvironment

Environment where the add-on is running.

Value	Description
`app`	Native app environment
`web`	Web browser environment

PlatformType

import { PlatformType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.PlatformType
Copied to your clipboard
import { PlatformType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.PlatformType

Specific platform/operating system where the add-on is running.

Value	Description
`iOS`	iOS mobile
`iPadOS`	iPadOS tablet
`chromeOS`	Chrome OS
`android`	Android mobile
`chromeBrowser`	Chrome browser
`firefoxBrowser`	Firefox browser
`edgeBrowser`	Edge browser
`samsungBrowser`	Samsung browser (note: contains typo in SDK)
`safariBrowser`	Safari browser
`unknown`	Unknown platform

Range

import { Range } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.Range
Copied to your clipboard
import { Range } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.Range

Page range options for document renditions.

Value	Description
`currentPage`	Generate rendition for the current page
`entireDocument`	Generate rendition for all pages
`specificPages`	Generate rendition for specific pages

RenditionFormat

import { RenditionFormat } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.RenditionFormat
Copied to your clipboard
import { RenditionFormat } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.RenditionFormat

Output formats for document renditions.

Value	MIME Type	Description
`jpg`	`"image/jpeg"`	JPEG image
`png`	`"image/png"`	PNG image
`mp4`	`"video/mp4"`	MP4 video
`pdf`	`"application/pdf"`	PDF document
`pptx`	`"application/vnd.openxmlformats-officedocument.presentationml.presentation"`	PowerPoint presentation

RenditionIntent

import { RenditionIntent } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.RenditionIntent
Copied to your clipboard
import { RenditionIntent } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.RenditionIntent

Intent for creating renditions (affects optimization).

Value	Description
`preview`	Intent to preview the content
`export`	Intent to export/download the content (default)
`print`	Intent to export and print the content (PDF optimized, not supported for MP4)

RenditionType

import { RenditionType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.RenditionType
Copied to your clipboard
import { RenditionType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.RenditionType

Type of rendition being created.

Value	Description
`page`	Page rendition (currently the only type)

RuntimeType

import { RuntimeType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.RuntimeType
Copied to your clipboard
import { RuntimeType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.RuntimeType

Runtime type of the entrypoint creating the backend object.

Value	Description
`panel`	Add-on's iframe runtime (code running in `index.html`)
`script`	Add-on's document sandbox code (code running in `code.js`)
`dialog`	Currently open dialog code

SupportedMimeTypes

import { SupportedMimeTypes } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// ⚠️ Named export only - NOT available in addOnUISdk.constants
Copied to your clipboard
import { SupportedMimeTypes } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// ⚠️ Named export only - NOT available in addOnUISdk.constants

MIME types for original source assets that can be converted to PDF.

Value	Description
`docx`	Microsoft Word document
`gdoc`	Google Docs document

Variant

import { Variant } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.Variant
Copied to your clipboard
import { Variant } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.Variant

Dialog variants that determine appearance and behavior.

Value	Description
`confirmation`	Ask user to confirm an action
`information`	Share information for user to acknowledge
`warning`	Share information user needs to consider before proceeding
`destructive`	Warn about actions that may impact data negatively
`error`	Communicate critical issue that needs resolution
`input`	Ask user to provide input
`custom`	Dialog that can render complex forms and content

VideoResolution

import { VideoResolution } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.VideoResolution
Copied to your clipboard
import { VideoResolution } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
// OR
addOnUISdk.constants.VideoResolution

Video resolution options for MP4 renditions.

Value	Description
`sd480p`	480p Standard Definition
`hd720p`	720p High Definition
`fhd1080p`	1080p Full High Definition
`qhd1440p`	1440p Quad High Definition
`uhd2160p`	2160p Ultra High Definition (4K)
`custom`	Custom resolution

Import Generator

Use these copy-paste ready import statements for common scenarios:

Complete Import (All Constants)

// Import everything (use this if you're unsure)
import addOnUISdk, { 
  // Import-required constants
  AppEvent, ColorPickerEvent, SupportedMimeTypes, EntrypointType,
  // Dual-access constants (most common)
  Range, RenditionFormat, RenditionIntent, Variant, ButtonType, FieldType,
  PlatformType, DeviceClass, PlatformEnvironment, EditorPanel, MediaTabs, ElementsTabs,
  AuthorizationStatus, DialogResultType, RuntimeType, BleedUnit, PanelActionType,
  ColorPickerPlacement, VideoResolution, FrameRate, BitRate, FileSizeLimitUnit, LinkOptions
} from "https://express.adobe.com/static/add-on-sdk/sdk.js";
Copied to your clipboard
// Import everything (use this if you're unsure)
import addOnUISdk, { 
  // Import-required constants
  AppEvent, ColorPickerEvent, SupportedMimeTypes, EntrypointType,
  // Dual-access constants (most common)
  Range, RenditionFormat, RenditionIntent, Variant, ButtonType, FieldType,
  PlatformType, DeviceClass, PlatformEnvironment, EditorPanel, MediaTabs, ElementsTabs,
  AuthorizationStatus, DialogResultType, RuntimeType, BleedUnit, PanelActionType,
  ColorPickerPlacement, VideoResolution, FrameRate, BitRate, FileSizeLimitUnit, LinkOptions
} from "https://express.adobe.com/static/add-on-sdk/sdk.js";

By Use Case

// Document Export & Rendering
import addOnUISdk, { Range, RenditionFormat, RenditionIntent } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// Modal Dialogs & UI
import addOnUISdk, { Variant, ButtonType, FieldType, DialogResultType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// Event Handling (Import Required!)
import addOnUISdk, { AppEvent, ColorPickerEvent } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// Platform Detection
import addOnUISdk, { PlatformType, DeviceClass, PlatformEnvironment } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// Editor Navigation
import addOnUISdk, { EditorPanel, MediaTabs, ElementsTabs, PanelActionType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// File Types & MIME (Import Required!)
import addOnUISdk, { SupportedMimeTypes } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// OAuth & Authorization
import addOnUISdk, { AuthorizationStatus } from "https://express.adobe.com/static/add-on-sdk/sdk.js";
Copied to your clipboard
// Document Export & Rendering
import addOnUISdk, { Range, RenditionFormat, RenditionIntent } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// Modal Dialogs & UI
import addOnUISdk, { Variant, ButtonType, FieldType, DialogResultType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// Event Handling (Import Required!)
import addOnUISdk, { AppEvent, ColorPickerEvent } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// Platform Detection
import addOnUISdk, { PlatformType, DeviceClass, PlatformEnvironment } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// Editor Navigation
import addOnUISdk, { EditorPanel, MediaTabs, ElementsTabs, PanelActionType } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// File Types & MIME (Import Required!)
import addOnUISdk, { SupportedMimeTypes } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

// OAuth & Authorization
import addOnUISdk, { AuthorizationStatus } from "https://express.adobe.com/static/add-on-sdk/sdk.js";

Add-on UI SDK Constants Guide - Practical examples and usage patterns
Import Quick Reference - Fast lookup for import requirements
Import Generator - Copy-paste ready import statements

dialog

Document Sandbox

Last updated 10/22/2025

Was this helpful?

Yes