From cd4b40d694da7354b30fec4f1ea1a36345571551 Mon Sep 17 00:00:00 2001 From: Edward Silverton Date: Fri, 24 Nov 2023 21:05:59 +0000 Subject: [PATCH] added comments --- .../extensions/uv-aleph-extension/config/Config.ts | 4 ++++ .../iiif/extensions/uv-av-extension/config/Config.ts | 10 ++++++++++ .../extensions/uv-ebook-extension/config/Config.ts | 8 +------- .../uv-model-viewer-extension/config/Config.ts | 4 ++++ 4 files changed, 19 insertions(+), 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 index ddee6908a..3f9958886 100644 --- 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 index bac9fb4db..5cd7708bb 100644 --- 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 index 7a6986387..cb0e326c9 100644 --- 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 index 1db550416..c86f29035 100644 --- 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; };