🤖 Merge PR DefinitelyTyped#72433 feat(openseadragon): upgrade, make several option.button accept Element by @hkleungai

Author: hkleungai

types/openseadragon/index.d.ts

@@ -119,7 +119,7 @@ declare namespace OpenSeadragon {
 
     function getElementStyle(element: Element | string): CSSStyleDeclaration;
 
-    function getViewer(element: Element): Viewer;
+    function getViewer(element: string | Element): Viewer;
 
     function getMousePosition(event?: OSDEvent<any>): Point;
 
@@ -350,14 +350,14 @@ declare namespace OpenSeadragon {
         showSequenceControl?: boolean | undefined;
         sequenceControlAnchor?: ControlAnchor | undefined;
         navPrevNextWrap?: boolean | undefined;
-        zoomInButton?: string | undefined;
-        zoomOutButton?: string | undefined;
-        homeButton?: string | undefined;
-        fullPageButton?: string | undefined;
-        rotateLeftButton?: string | undefined;
-        rotateRightButton?: string | undefined;
-        previousButton?: string | undefined;
-        nextButton?: string | undefined;
+        zoomInButton?: string | Element | undefined;
+        zoomOutButton?: string | Element | undefined;
+        homeButton?: string | Element | undefined;
+        fullPageButton?: string | Element | undefined;
+        rotateLeftButton?: string | Element | undefined;
+        rotateRightButton?: string | Element | undefined;
+        previousButton?: string | Element | undefined;
+        nextButton?: string | Element | undefined;
         sequenceMode?: boolean | undefined;
         /**
          * If sequenceMode is true, display this page initially.

types/openseadragon/openseadragon-tests.ts

@@ -11,7 +11,118 @@ import OpenSeadragon, {
 // @ts-expect-error
 OpenSeadragon.setString("abc", 123);
 
-const viewer = OpenSeadragon({ id: "viewerid" });
+let viewer: OpenSeadragon.Viewer;
+viewer = OpenSeadragon({});
+viewer = OpenSeadragon({
+    id: "id",
+    prefixUrl: "prefixUrl",
+    navigatorId: "navigatorId",
+    navigatorBackground: "navigatorBackground",
+    navigatorBorderColor: "navigatorBorderColor",
+    navigatorDisplayRegionColor: "navigatorDisplayRegionColor",
+    referenceStripScroll: "referenceStripScroll",
+    referenceStripPosition: "referenceStripPosition",
+    tabIndex: 0,
+    blendTime: 0,
+    defaultZoomLevel: 0,
+    opacity: 0,
+    degrees: 0,
+    minZoomLevel: 0,
+    maxZoomLevel: 0,
+    minZoomImageRatio: 0,
+    maxZoomPixelRatio: 0,
+    smoothTileEdgesMinZoom: 0,
+    minScrollDeltaTime: 0,
+    pixelsPerWheelLine: 0,
+    pixelsPerArrowPress: 0,
+    visibilityRatio: 0,
+    imageLoaderLimit: 0,
+    clickTimeThreshold: 0,
+    clickDistThreshold: 0,
+    dblClickTimeThreshold: 0,
+    dblClickDistThreshold: 0,
+    springStiffness: 0,
+    animationTime: 0,
+    zoomPerClick: 0,
+    zoomPerScroll: 0,
+    zoomPerSecond: 0,
+    navigatorSizeRatio: 0,
+    navigatorOpacity: 0,
+    controlsFadeDelay: 0,
+    controlsFadeLength: 0,
+    maxImageCacheCount: 0,
+    timeout: 0,
+    minPixelRatio: 0,
+    initialPage: 0,
+    referenceStripHeight: 0,
+    referenceStripWidth: 0,
+    referenceStripSizeRatio: 0,
+    collectionRows: 0,
+    collectionColumns: 0,
+    collectionTileSize: 0,
+    collectionTileMargin: 0,
+    rotationIncrement: 0,
+    debugMode: true,
+    alwaysBlend: true,
+    autoHideControls: true,
+    immediateRender: true,
+    preload: true,
+    flipped: true,
+    homeFillsViewer: true,
+    panHorizontal: true,
+    panVertical: true,
+    constrainDuringPan: true,
+    wrapHorizontal: true,
+    wrapVertical: true,
+    iOSDevice: true,
+    autoResize: true,
+    preserveImageSizeOnResize: true,
+    showNavigator: true,
+    navigatorMaintainSizeRatio: true,
+    navigatorAutoResize: true,
+    navigatorAutoFade: true,
+    navigatorRotate: true,
+    useCanvas: true,
+    mouseNavEnabled: true,
+    showNavigationControl: true,
+    showZoomControl: true,
+    showHomeControl: true,
+    showFullPageControl: true,
+    showRotationControl: true,
+    showFlipControl: true,
+    showSequenceControl: true,
+    navPrevNextWrap: true,
+    sequenceMode: true,
+    preserveViewport: true,
+    preserveOverlays: true,
+    showReferenceStrip: true,
+    collectionMode: true,
+    ajaxWithCredentials: true,
+    loadTilesWithAjax: true,
+    imageSmoothingEnabled: true,
+});
+
+declare const buttonElement: Element;
+viewer = OpenSeadragon({
+    zoomInButton: "zoomInButton-id",
+    zoomOutButton: "zoomOutButton-id",
+    homeButton: "homeButton-id",
+    fullPageButton: "fullPageButton-id",
+    rotateLeftButton: "rotateLeftButton-id",
+    rotateRightButton: "rotateRightButton-id",
+    previousButton: "previousButton-id",
+    nextButton: "nextButton-id",
+});
+viewer = OpenSeadragon({
+    zoomInButton: buttonElement,
+    zoomOutButton: buttonElement,
+    homeButton: buttonElement,
+    fullPageButton: buttonElement,
+    rotateLeftButton: buttonElement,
+    rotateRightButton: buttonElement,
+    previousButton: buttonElement,
+    nextButton: buttonElement,
+});
 
 // @ts-expect-error
 viewer.addHandler("canvas-click", ({ fullScreen }) => {

types/openseadragon/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/openseadragon",
-    "version": "3.0.9999",
+    "version": "4.1.9999",
     "projects": [
         "https://openseadragon.github.io/"
     ],