From 497e546129b047b926359e6fbe2fe2dbd59badfd Mon Sep 17 00:00:00 2001 From: Manav Rathi Date: Thu, 2 Jan 2025 16:22:14 +0530 Subject: [PATCH] Doc --- .../photos/src/components/PhotoViewer/index.tsx | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/web/apps/photos/src/components/PhotoViewer/index.tsx b/web/apps/photos/src/components/PhotoViewer/index.tsx index b6473bd737..ec0b9f3fc8 100644 --- a/web/apps/photos/src/components/PhotoViewer/index.tsx +++ b/web/apps/photos/src/components/PhotoViewer/index.tsx @@ -71,9 +71,23 @@ export type PhotoViewerProps = Pick< PhotoFrameProps, "favoriteFileIDs" | "markUnsyncedFavoriteUpdate" | "markTempDeleted" > & { + /** + * The PhotoViewer is shown when this is `true`. + */ isOpen: boolean; + /** + * The list of files that we are showing in the current context. + * + * These are the (ordered) siblings of the file that is currently being + * shown in the PhotoViewer. The meaning of siblings depends on the context: + * for example, when viewing a collection, this will be set to the list of + * files present in the collection. + */ items: any[]; currentIndex?: number; + /** + * Callback fired when the PhotoViewer requests to be closed. + */ onClose?: (needUpdate: boolean) => void; gettingData: (instance: any, index: number, item: EnteFile) => void; forceConvertItem: (instance: any, index: number, item: EnteFile) => void;