@iiif/manifold

[![Build Status](https://travis-ci.org/IIIF-Commons/manifold.svg?branch=master)](https://travis-ci.org/IIIF-Commons/manifold)

Stats

StarsIssuesVersionUpdatedCreatedSize
@iiif/manifold
3102.0.53 months ago4 years agoMinified + gzip package size for @iiif/manifold in KB

Readme

manifold

Build Status

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

Publishing Package

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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.