Components Configuration

The components property is optional and provides a way to customize components used within a Canopy IIIF project.

Viewer

The viewer property is used to specify the default viewer for your Canopy IIIF project. The viewer is responsible for rendering IIIF Manifests to work/* routes. Canopy IIIF currently supports two viewers: Clover and Ramp.

Clover IIIF

The default viewer is Clover IIIF (opens in a new tab), which is a lightweight, fast, and responsive image viewer. It is designed to work with IIIF images, video, and audio, and provides a simple interface interacting with IIIF Manifests. Explicitly setting the viewer to Clover is optional behavior and does not require any additional configuration.

{
  "collection": "https://example.org/iiif/collection.json",
  "components": {
    "viewer": "clover"
  }
}

Ramp

Ramp (opens in a new tab) is an A/V focused viewer that is designed to work with media, annotations, structured navigation, and transcripts associated with a IIIF Manifests.

{
  "collection": "https://example.org/iiif/collection.json",
  "components": {
    "viewer": "ramp"
  }
}