Missing documentation for ui-modal

App Bridge
,
1

Hi everyone,

I am having trouble finding any official documentation or mentions of the ui-modal component for App Bridge.

The official documentation for the Modal API focuses on s-modal. However, s-modal appears to be a Polaris component and does not seem to support certain attributes available in ui-modal. Specifically, ui-modal allows for variant="max" and the use of the src attribute to load a remote URL.

Since ui-modal is not explicitly documented on the Modal API page, I have a few questions:

  1. Is ui-modal currently deprecated or scheduled for removal?
  2. Is there a reason why these specific attributes (variant and src) are not covered in the standard documentation?
  3. Is the intended path forward to migrate toward s-app-window for these use cases?

I am having a hard time drawing a clear line between App Bridge and Polaris components in the documentation. It feels cluttered and incomplete.

Any clarity would be greatly appreciated. Thanks!

2

HI @TobiasDalhof

Iā€™m digging into this myself - but our general recommendation is to migrate to s-model or s-app-window - s-app-window does have a property for src - would this work for your use case?

3

Hi @Liam-Shopify

Yes, s-app-window should work for my use case.

However, I brought this up because many apps currently use ui-modal with variant="max", yet it remains undocumented. It is a significant hurdle when documentation is removed or missing, forcing us to rely on the forums for answers that are often vague, non-binding, or outdated.

This lack of clarity makes it difficult to build with confidence and is a major friction point for the adoption of Polaris web components. Clearer distinctions and better maintenance of the component references would be very helpful.

1 Like