Spectrum UXP Reference

UXP supports the UI to be written in three ways using standard HTML Elements, built-in Spectrum UXP widgets, and Spectrum Web Components (recently added)

But before we proceed, it's important to understand some terminology

• Spectrum - An open-source design language and guidelines provided by Adobe.
• Web components - HTML5 Web technology lets you define custom HTML tags.
• Adobe Spectrum Web Components (popularly known as SWC) - An open-source library that has Spectrum-styled web components.

With that in mind, let's get into the details:

• HTML elements
  These are pure HTML elements following the web standards. For example, <img>, <dialog> etc. You have the flexibility to style them with your custom stylesheet. Check out the list of supported HTML tags and elements.

• Spectrum UXP widgets
  These are built-in Spectrum-styled UXP components. These widgets mimic the Adobe SWC library APIs and expose a subset of the functionality of the corresponding SWC.

  You can use them as you would any other HTML tag. For example,

  Copy
  <sp-button variant="primary">I'm a Spectrum button</sp-button>
  Copied to your clipboard
  <sp-button variant="primary">I'm a Spectrum button</sp-button>

  Take a look at the list of UXP-supported Spectrum widgets - User Interface and Typography

• UXP Spectrum web components
  These are the Adobe Spectrum Web Components, supported from UXP v7.0 onwards. It's built using Web Components technology.

  In order to use them, you are required to install the components individually and then import them before using the component tag. For example,

  Copy
  npm i @swc-uxp-wrappers/button
  Copied to your clipboard
  npm i @swc-uxp-wrappers/button

  Copy
  import '@swc-uxp-wrappers/button/sp-button.js';
  Copied to your clipboard
  import '@swc-uxp-wrappers/button/sp-button.js';

Copy
<sp-button variant="primary">I'm a SWC button</sp-button>
Copied to your clipboard
<sp-button variant="primary">I'm a SWC button</sp-button>

Note that although the tag appears to be identical to Spectrum UXP widgets, the way they are implemented is fundamentally different. Read on to learn more about the differences.

Differences

Now that you know the various options, you must understand their differences and limitations

• HTML elements
  Keep in mind that UXP is not a browser. It's a platform that provides the ease of using web technologies to build plugins/scripts for desktop applications. Hence, it does not support all the HTML/CSS capabilities you can use in a browser. In fact, the tags that are not supported are treated like simple <div>.

  Do take a look at the list of HTML elements, and attributes that are not supported.

• Spectrum UXP widgets
  Remember that these are built-in within UXP. Therefore, they may appear to be a black-box solution that does not allow you to peek into the details during debugging or alter their behavior easily.

  

• UXP Spectrum web components
  The support for SWC in UXP is more extensive. It has 30 components including some unique ones that are not available in Spectrum widgets such as table, toast, card etc. Plus, these components follow the principles of SWC and web components, which means
  1. You need to install and import individual comps before using them
  2. You can debug SWC like a regular Web Component

That said, you can mix and match these three offerings to suit your use case. For example, the following will work seamlessly

Copy
<form> <!-- plain HTML element -->
   <sp-banner> <!-- Spectrum Web Component -->
     <div slot="header">Header text</div>
     <div slot="content">Content of the banner</div>
  </sp-banner>
  <sp-button variant="primary">I'm a button</sp-button> <!-- Spectrum widget -->
</form>
Copied to your clipboard
<form> <!-- plain HTML element -->
   <sp-banner> <!-- Spectrum Web Component -->
     <div slot="header">Header text</div>
     <div slot="content">Content of the banner</div>
  </sp-banner>
  <sp-button variant="primary">I'm a button</sp-button> <!-- Spectrum widget -->
</form>

What's best for you?

The choice you make depends on your use case and the stage of development you are in.

If you are looking for a ready-made Adobe Spectrum-styled UI or are just getting started with programming your UI, we recommend you start your journey with SWC. Fall back to Spectrum UXP widgets for variants in the comps that are not available yet. And use plain HTML elements when they are not available in either.

However, if you prefer vanilla HTML and don't mind undertaking the efforts of styling, use the HTML elements along with your custom stylesheet. In fact, you can build your own custom tags using Web Components.

If you are thinking of upgrading your existing UI, you should check out the new components in SWC that are not available with Spectrum UXP widgets.

Visit the following topics to learn about them in detail

• Spectrum Web Components
• Spectrum UXP widgets
• Spectrum widgets to SWC Mapping

Last updated 3/8/2023

Was this helpful?

Yes

No