added comments

britishlibrary · Nov 24, 2023 · cd4b40d · cd4b40d
1 parent c8f1aa4
commit cd4b40d
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 7 deletions.
diff --git a/src/content-handlers/iiif/extensions/uv-aleph-extension/config/Config.ts b/src/content-handlers/iiif/extensions/uv-aleph-extension/config/Config.ts
@@ -16,9 +16,13 @@ import {
 } from "../../config/ExpandPanel";
 
 type AlephLeftPanelOptions = ExpandPanelOptions & {
+  /** Determines if the console tab is enabled */
   consoleTabEnabled: boolean;
+  /** Determines if the graph tab is enabled */
   graphTabEnabled: boolean;
+  /** Determines if the settings tab is enabled */
   settingsTabEnabled: boolean;
+  /** Determines if the source tab is enabled */
   srcTabEnabled: boolean;
 };
 

diff --git a/src/content-handlers/iiif/extensions/uv-av-extension/config/Config.ts b/src/content-handlers/iiif/extensions/uv-av-extension/config/Config.ts
@@ -12,15 +12,25 @@ import {
 } from "@/content-handlers/iiif/BaseConfig";
 
 type AVCenterPanelOptions = CenterPanelOptions & {
+  /** Determines if the poster image is expanded */
   posterImageExpanded: boolean;
+  /** Determines if media errors are hidden */
   hideMediaError: boolean;
+  /** Determines if parent is included in title */
   includeParentInTitleEnabled: boolean;
+  /** Field for subtitle metadata */
   subtitleMetadataField: string;
+  /** Determines if auto play is enabled */
   autoPlay: boolean;
+  /** Determines if fast forward is enabled */
   enableFastForward: boolean;
+  /** Determines if fast rewind is enabled */
   enableFastRewind: boolean;
+  /** Ratio of the poster image */
   posterImageRatio: number;
+  /** Determines if limit is set to range */
   limitToRange: boolean;
+  /** Determines if ranges auto advance */
   autoAdvanceRanges: boolean;
 };
 

diff --git a/src/content-handlers/iiif/extensions/uv-ebook-extension/config/Config.ts b/src/content-handlers/iiif/extensions/uv-ebook-extension/config/Config.ts
@@ -15,13 +15,7 @@ import {
   ExpandPanelOptions,
 } from "../../config/ExpandPanel";
 
-type EbookLeftPanelOptions = ExpandPanelOptions & {
-  expandFullEnabled: boolean;
-  panelAnimationDuration: number;
-  panelCollapsedWidth: number;
-  panelExpandedWidth: number;
-  panelOpen: boolean;
-};
+type EbookLeftPanelOptions = ExpandPanelOptions & {};
 
 type EbookLeftPanelContent = ExpandPanelContent & {
   title: string;

diff --git a/src/content-handlers/iiif/extensions/uv-model-viewer-extension/config/Config.ts b/src/content-handlers/iiif/extensions/uv-model-viewer-extension/config/Config.ts
@@ -12,9 +12,13 @@ import {
 } from "@/content-handlers/iiif/BaseConfig";
 
 type ModelViewerCenterPanelOptions = CenterPanelOptions & {
+  /** Determines if auto rotation is enabled */
   autoRotateEnabled: boolean;
+  /** Delay in camera change */
   cameraChangeDelay: number;
+  /** Determines if double click annotation is enabled */
   doubleClickAnnotationEnabled: boolean;
+  /** Determines if interaction prompt is enabled */
   interactionPromptEnabled: boolean;
 };