diff --git a/.codesandbox/ci.json b/.codesandbox/ci.json index 67d70a5e..a2324732 100644 --- a/.codesandbox/ci.json +++ b/.codesandbox/ci.json @@ -1,9 +1,7 @@ { "installCommand": "custom-install", "buildCommand": "custom-build", - "packages": [ - "packages/canvas-panel" - ], + "packages": ["packages/canvas-panel"], "sandboxes": [ "new", "canvas-panel-web-component-demo-image-service-forked-174cgb", @@ -36,5 +34,5 @@ "/sandboxes/01-show-canvas/flexbox.csb", "/sandboxes/00-intro/intro-script.csb" ], - "node": "16" + "node": "18" } diff --git a/docs/api-reference/vault.md b/docs/api-reference/vault.md index 9d0942e3..6e3b12dc 100644 --- a/docs/api-reference/vault.md +++ b/docs/api-reference/vault.md @@ -7,16 +7,33 @@ title: Vault import { GitHubDiscussion } from "../../GitHubDiscussion.js"; - -Vault is the library used by Canvas Panel to load, normalise and track IIIF resources. If using Canvas Panel solely as a tag, controlling its behaviour by setting attributes, you don't need to interact with Vault directly. But if you are bringing IIIF to Canvas Panel via script, you use Vault to manage IIIF resources. - -Any IIIF resource loaded into Vault is then available _through_ Vault as _normalised_, 100% compliant IIIF Presentation API 3.0, even if it started out as IIIF Presentation 2.0, or 2.1. This process of normalisation gives you a consistent programming interface, without having to worry about the various forms that the JSON-LD can take before version 3 of the Presentation API. It also allows you to develop event-driven applications, because you can associate event listeners directly with the IIIF resources managed and tracked in Vault. You can also _subscribe_ to changes in the data in Vault, reacting to changes in the resources managed by Vault. - -This documentation site is full of examples showing Vault usage alongside Canvas Panel. But it helps to begin by showing how Vault is used for general IIIF purposes, before introducing its use with Canvas Panel. +Vault is the library used by Canvas Panel to load, normalise and track IIIF +resources. If using Canvas Panel solely as a tag, controlling its behaviour by +setting attributes, you don't need to interact with Vault directly. But if you +are bringing IIIF to Canvas Panel via script, you use Vault to manage IIIF +resources. + +Any IIIF resource loaded into Vault is then available _through_ Vault as +_normalised_, 100% compliant IIIF Presentation API 3.0, even if it started out +as IIIF Presentation 2.0, or 2.1. This process of normalisation gives you a +consistent programming interface, without having to worry about the various +forms that the JSON-LD can take before version 3 of the Presentation API. It +also allows you to develop event-driven applications, because you can associate +event listeners directly with the IIIF resources managed and tracked in Vault. +You can also _subscribe_ to changes in the data in Vault, reacting to changes in +the resources managed by Vault. + +This documentation site is full of examples showing Vault usage alongside Canvas +Panel. But it helps to begin by showing how Vault is used for general IIIF +purposes, before introducing its use with Canvas Panel. ## Installation -If you have Canvas Panel available on your page, you already have Vault, too. But you can use it on its own, without Canvas Panel. See the [installation instructions](../../docs/installation) for the full details. In the following example, Vault is loaded from a CDN, avoiding any need to build or run a server. +If you have Canvas Panel available on your page, you already have Vault, too. +But you can use it on its own, without Canvas Panel. See the +[installation instructions](../../docs/installation) for the full details. In +the following example, Vault is loaded from a CDN, avoiding any need to build or +run a server. The next few examples use this HTML page to help make the demonstration visible. @@ -26,38 +43,45 @@ The next few examples use this HTML page to help make the demonstration visible.