/image-gallery-viewer

Image Gallery Viewer that integrates with OpenSeadragon to provide deep zoom capabilities for high-resolution images

Primary LanguageTypeScript

Image Gallery Viewer

A React-based Image Gallery Viewer that integrates with OpenSeadragon to provide deep zoom capabilities for high-resolution images. The project includes a set of components to handle image viewing, zooming, navigation between multiple images, and full-screen capabilities.

CodeSandbox Project: Link

Running Demo: Link


ImageGallery Component

The ImageGallery component serves as the core of the image gallery viewer.

Features

  • Image Navigation: Navigate through multiple images.
  • Zooming Capabilities: Zoom in and out of images for detailed viewing.
  • Full-Screen Mode: Full-screen viewing capabilities.
  • Thumbnail Previews: Thumbnail view to easily switch between images.

Props

Prop Type Default Description
iiifUrls array Required An array of URLs pointing to the IIIF-compliant images.
width string "800px" The width of the viewer.
height string "500px" The height of the viewer.
showToolbar boolean true Toggle the display of the toolbar.

Usage

<ImageGallery
  iiifUrls={imageUrls}
  width="800px"
  height="600px"
  showToolbar={true}
/>

Installation Guide for the App

  1. Clone the Repository: First, you'll need to clone the project repository to your local machine.

    git clone git@github.com:fahmyfarahat/image-gallery-viewer.git
  2. Navigate to the Project Directory:

    cd image-gallery-viewer
  3. Install Yarn (if not installed): If you don't have Yarn installed, you can install it by running:

    npm install --global yarn
  4. Install Dependencies: Inside the project directory, install all the required dependencies by running:

    yarn install
  5. Start the Development Server: You can now start the development server by running:

    yarn start

    This will start the server, and the app should be accessible at http://localhost:3000 or another port if you've configured it differently.


What are IIIF Images?

IIIF Images refer to images that are hosted and served using the IIIF standards. These images are accessible through a set of APIs that enable users to perform various operations on them. The IIIF standards allow for:

  • Deep Zooming: Users can zoom into high-resolution images to see fine details.
  • Image Manipulation: Functions such as rotation, mirroring, and color adjustments.
  • Interoperability: Different IIIF-compliant viewers can access and interact with IIIF images, allowing institutions to share and collaborate on image resources.
  • Annotations: Ability to add commentary or other forms of linked information directly on the image.

How to Access IIIF Images from The Getty

The Getty is among the cultural institutions that have adopted the IIIF standards for their digital collections. Here's how you can access IIIF images from The Getty:

  1. Visit The Getty's Website: Navigate to The Getty's digital collection.

  2. Search for Images: Utilize their search functionality to find the images you're interested in.

  3. Access IIIF Manifests: Many digital objects on The Getty's site will have IIIF icons or links that lead to the IIIF manifests. A manifest is a JSON document that describes the structure and layout of a complex image or object.

  4. Use in IIIF-Compatible Viewers: The manifests can be used in any IIIF-compatible viewer, such as OpenSeadragon, to view and manipulate the images.

  5. API Access: Developers can access the IIIF images programmatically via The Getty's APIs, allowing for integration into custom web applications or other digital projects.