https://github.com/IIIF-Commons/manifold

Wraps Manifesto to provide viewer state and related utilities
https://github.com/IIIF-Commons/manifold

iiif typescript

Last synced: 5 months ago
JSON representation

Wraps Manifesto to provide viewer state and related utilities

• Host: GitHub
• URL: https://github.com/IIIF-Commons/manifold
• Owner: IIIF-Commons
• License: mit
• Created: 2016-05-31T14:16:55.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-04-17T15:38:11.000Z (6 months ago)
• Last Synced: 2025-04-18T05:31:34.758Z (6 months ago)
• Topics: iiif, typescript
• Language: TypeScript
• Homepage:
• Size: 2.53 MB
• Stars: 7
• Watchers: 3
• Forks: 12
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-iiif - Manifold - Wraps Manifesto to provide viewer state and related utilities. (Presentation API Libraries / Image viewers (Image API only))

README

          
# manifold

[![Build Status](https://github.com/IIIF-Commons/manifold/actions/workflows/build-test.yml/badge.svg?branch=master)](https://github.com/IIIF-Commons/manifold/actions/workflows/build-test.yml)

    npm install @iiif/manifold --save

Stateful utils on top of manifesto. Returns a `helper` object that can be used to navigate a IIIF manifest.

e.g.

- `getMetadata`: returns all metadata for current image, range, canvas, sequence, manifest)

- `getCurrentRange`, `getPreviousRange`, `getNextRange`: Used to navigate a flattened range tree (useful for IIIF AV scenarios)

- `getTree`: Returns a default tree (sortable by `navDate`) of collections, manifests, ranges, or a tree based on a given top range.

Has an ajax implementation of manifesto's `IExternalResource` (used in the IIIF auth flow).

## Getting Started

### Documentation

https://iiif-commons.github.io/manifold/

### Developer Setup

    git clone https://github.com/iiif-commons/manifold.git

    npm install

    npm run build

### Testing the build

The build can be run and tested in the browser console by running

    npm start

and navigating to examples/index.html.

### Publishing Package

    git checkout master

    npm version patch

    git add .

    git commit -m "Release v1.2.3"

    git tag v1.2.3

    git push origin master v1.2.3