Skip to content

Document preview API changes#36

Merged
cornea-robert merged 2 commits into
RWS:mainfrom
aapetean:preview_api_changes
Jun 12, 2026
Merged

Document preview API changes#36
cornea-robert merged 2 commits into
RWS:mainfrom
aapetean:preview_api_changes

Conversation

@aapetean

Copy link
Copy Markdown

Add documentation for preview API changes introduced in 2026

@aapetean aapetean requested a review from cornea-robert June 12, 2026 11:41
| `ExternalHtml` | Opens the preview file in the default browser. |

> [!NOTE]
> Using a preview UI that is not in this list is not yet supported in Studio

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use Var:ProductName instead of Studio

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

`BuildPreviewApplication` on the File Type Component Builder and returning a
custom `UserControl` or a `GenericExternalPreviewApplication` instance.

Starting with Studio 2026, **Studio ships a set of built-in preview UIs**.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace it with : Var:ProductName 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


> [!NOTE]
> Using a Preview ID that is not in this list is not yet supported. Custom
> third-party preview UIs cannot be registered in Studio 2026.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Var:ProductName 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

## Migration checklist

Use this checklist when updating an existing file type plugin to target
Studio 2026.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Var:ProductName 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@cornea-robert cornea-robert merged commit 4bfff88 into RWS:main Jun 12, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants