@iiif/manifold
TypeScript icon, indicating that this package has built-in type declarations

2.1.1 • Public • Published

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

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

/@iiif/manifold/

    Package Sidebar

    Install

    npm i @iiif/manifold

    Weekly Downloads

    2,208

    Version

    2.1.1

    License

    MIT

    Unpacked Size

    1.84 MB

    Total Files

    195

    Last publish

    Collaborators

    • sdellis
    • edsilv-admin
    • mejackreed
    • stephenwf
    • adamjarling
    • demiankatz
    • glen.robson