Skip to content

Background panel config - #1939

Merged
jamesmisson merged 5 commits into
UniversalViewer:UIfrom
jamesmisson:background-panel-config
Nov 3, 2026
Merged

jamesmisson merged 5 commits into
UniversalViewer:UIfrom
jamesmisson:background-panel-config

Conversation

@jamesmisson

Copy link
Copy Markdown
Contributor

Following on from the panel restructure, this splits out the OpenSeadragonBackgroundPanel config from the original OpenSeadragonCenterPanel config, and implements it in the new background component.

To keep the established pattern of inheritance in the config, I've created a currently empty config for the general BackgroundPanel too. If in the future other extensions use the center panel/background panel structure, then the BackgroundPanel base config will come in useful.

This will be a breaking change for deployments that supply an external config according to the v4 center panel config.

Sprint issue: #1875

@vercel

vercel Bot commented Nov 3, 2026

Copy link
Copy Markdown

@jamesmisson is attempting to deploy a commit to the Universal Viewer Team on Vercel.

A member of the Team first needs to authorize it.

@vercel

vercel Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
universalviewer Ready Ready Preview Nov 3, 2026 12:07pm UTC

Request Review

@demiankatz demiankatz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks, @jamesmisson, this refactoring looks reasonable, and applying configurations seems to work as expected.

A few notes/comments:

1.) We should start building a document somewhere listing all of the backward-breaking changes in the next major release. Perhaps a MIGRATING.md file?

2.) I don't really like the way configurations are associated with modules; it feels to me like these OSD settings should live somewhere more generic, and moving the functionality from one module to another shouldn't really make any difference. But the config system we have is the config system we have, and now is not the time to change it. I just feel that it can and should be made better someday!

3.) I tested by adjusting the defaultZoomLevel setting (among others). I have no idea how defaultZoomLevel works; every value I entered caused weird results. We should probably improve the documentation for this setting -- though that's obviously an entirely separate concern, as it's not a new problem here.

@jamesmisson

Copy link
Copy Markdown
Contributor Author

Thanks @demiankatz , agreed on all of those points, especially number 2 - if any of these options had been needed in both components, this would have got messy.

@jamesmisson jamesmisson closed this Nov 3, 2026
@demiankatz

Copy link
Copy Markdown
Contributor

@jamesmisson, did you mean to close this instead of merging it?

@jamesmisson jamesmisson reopened this Nov 3, 2026
@jamesmisson
jamesmisson merged commit 03bff09 into UniversalViewer:UI Nov 3, 2026
6 of 7 checks passed
@jamesmisson

Copy link
Copy Markdown
Contributor Author

Nope - that's what I get for trying to use GitHub on my phone! Thanks

@K8Sewell K8Sewell mentioned this pull request Nov 3, 2026
1 task

This branch was successfully deployed

1 active deployment
Preview – universalviewer — a3fd0302 Deployed Nov 3, 2026 by vercel[bot]
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