Skip to content
Jon Cameron edited this page Feb 27, 2024 · 18 revisions

What is Ramp?

Ramp is a component library which consumes a IIIF Presentation 3.0 API Manifest to display audiovisual resources. It was previously known as the Avalon IIIF React Media Player. It is written using ReactJS, a free and open-source front-end JavaScript library for building user interfaces and UI components. One of the reasons to use ReactJS in developing this is its simplicity and flexibility, along with improvements in better performance and user experience due to its use of the Virtual DOM. Ramp is exported as an NPM package.

List of Components

The component library exports the following components:

  • AutoAdvanceToggle: renders behavior property of a given Manifest
  • IIIFPlayer: the media player created using the VideoJS HTML5 player framework
  • MarkersDisplay: renders highlighting annotations in a Canvas
  • MediaPlayer: renders the player with Video.js
  • MetadataDisplay: lists metadata in the IIIF Manifest
  • StructuredNavigation: renders the content structure from a IIIF Presentation 3.0 Manifest
  • SupplementalFiles: renders supplemental files with alternate representations of the resource
  • Transcript: renders transcript data related to the A/V content