@iiif/manifold

manifold

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 build
npm test

Publishing Package

• Bump the version locally using npm version on a branch other than master. Example: npm version patch -m 'bump to v3.0.42'
• Push the bump version branch to GitHub and create a pull request to master.
• After the pull request is merged, checkout master and pull the latest changes. git checkout master && git pull
• Run npm publish
• Push the git tags created git push --tags