TIFY is a slim and mobile-friendly IIIF document viewer. 

A slim and mobile-friendly IIIF document viewer

tify

TIFY is a slim and mobile-friendly IIIF document viewer.

  "description": "TIFY is a slim and mobile-friendly IIIF document viewer.",

    "url": "https://github.com/tify-iiif-viewer/tify"

    "url": "https://github.com/tify-iiif-viewer/tify/issues"

    "e2e": "node tests/e2e/runner.js --headless",

    "lint-fix": "vue-cli-service lint --fix",

    "postinstall": "node build/create-icons.js",

    "postversion": "echo 'Update version in README.md, then run \"git add README.md && git commit --amend --no-edit && git tag v'$npm_package_version' && git push && git push --tags\", and finally \"npm publish\" to publish '$npm_package_name' on npmjs.com.'",

    "preversion": "npm install-clean && npm run test",

    "serve-mock-api": "node tests/iiif-api/server.js",

    "test": "npm run unit && npm run e2e",

    "version": "npm run build && git add dist"

    "@vue/cli-plugin-e2e-cypress": "~4.5.19",

    "@vue/cli-plugin-unit-jest": "^4.5.19",

    "@vue/eslint-config-airbnb": "^6.0.0",

    "eslint-plugin-vuejs-accessibility": "^1.2.0",

    "vue-automatic-import-loader": "^1.0.0",

TIFY is a slim and mobile-friendly [IIIF](https://iiif.io/) document viewer built with [Vue.js](https://vuejs.org/). It supports version 2 of the IIIF [Presentation API](https://iiif.io/api/presentation/2.1/) and [Image API](https://iiif.io/api/image/2.1/). Support for version 3 APIs is coming in the near future.

Continue reading to learn how to integrate TIFY into your website or application and about its options and API, [check out the website for usage examples](https://tify.rocks/), or [have a look at the user guide](doc/user-guide.en.md).

TIFY is available as an [npm package](https://www.npmjs.com/package/tify):

Embed TIFY into your website in three easy steps:

1. Include both the JavaScript and the stylesheet.

	- Either download TIFY and copy the contents of the `dist` directory to your server:

		> To avoid issues with browser caching, add a query parameter with the current version, e.g. `?v0.28.0`.

		> To avoid issues with browser caching, add a query parameter with the current version, e.g. `?v0.28.1`.

	- Or use [jsDelivr](https://www.jsdelivr.com/):

	- Or `import` TIFY into your web application:

2. Add an HTML block element with an `id` and set its `height`.

	  manifestUrl: 'https://example.org/iiif-manifest.json',

Many aspects of the theme can be modified with SCSS variables or CSS custom properties, allowing you to easily adapt TIFY’s appearance to your website. [See the theme settings file](src/styles/util/settings.scss) for all available variables.

If you are are upgrading from any previous version, [have a look at the upgrading guidelines](UPGRADING.md).

TIFY takes an options object as its only parameter. While optional, you usually want to set `container` and `manifestUrl`.

- **`childManifestAutoloaded`**: boolean, default `true`

	If the manifest set by `manifestUrl` is a collection (`@type` is `sc:Collection`) and `childManifestUrl` is not set, automatically load the first manifest in the collection. This only works for collections with `manifests` on the first level; when the collection only contains other collection and `childManifestUrl` is not set, only the collection view is shown until the user selects a child manifest to load.

- **`childManifestUrl`**: string or `null` (default)

	If the manifest set by `manifestUrl` is a collection (`@type` is `sc:Collection`), additionally load another IIIF manifest, whose `@type` must be `sc:Manifest`. Note that TIFY does not check if this additional manifest is actually part of the collection.

- **`container`**: string or HTMLElement or `null` (default)

	The HTML element into which TIFY is mounted. If set to `null`, TIFY is not mounted at all until `mount` is called (see [API](#api)).

	Sets the initial image filters. Available properties are `'brightness'`, `'contrast'` (both a floating-point number between `0.5` and `2`) and `'saturation'` (floating-point number between `0` and `3`), all optional.

	The interface language, matching the translation filename without extension. [See which translations are available](https://github.com/tify-iiif-viewer/tify/tree/main/dist/translations) or add your own.

- **`manifestUrl`**: string or `null` (default)

- **`optionsResetOnPageChange`**: array of strings, default `['pan']`

	Viewer options that are reset on page change. Allowed array values are `'filters'`, `'pan'`, `'rotation'` and `'zoom'`.

- **`pageLabelFormat`**: string, default `'P : L'`

	Defines how page labels are displayed in the page selector and in the thumbnails view. The placeholder `P` is replaced by the physical page number (consecutive numbers starting at `1`) while `L` is replaced by the logical page label, which can be any string, defined by the manifest.

- **`pages`**: array of 1-based integers or `null` (default)

	The page(s) to display initially. If `null`, the initial page is determined by the manifest’s `startCanvas`, and if that is not set either, the first page is displayed. Page numbers start at 1.

	Sets the initial pan. The object has two optional properties `x` and `y`, both floating-point numbers. The higher the value, the more to the left respectively top the image is positioned. By default, the image is centered within the container.

- **`translationsDirUrl`**: string or `null` (default)

	The URL of the directory where TIFY finds its translations, without trailing `/`. If not set, TIFY tries to determine this URL automatically from its `<script>` element, but this may not work depending on how TIFY is loaded.

- **`urlQueryKey`**: string or `null` (default), only use characters `A…Z a…z 0…9 - _`

	If set, parameters are read from the URL query and any changes are reflected, using the key provided. This works with multiple concurrent instances, but each instance must use a unique key. Note that when `urlQueryKey` is set, all options defined by `urlQueryParams` can be overridden by changing the URL in the browser’s address bar.

- **`urlQueryParams`**: array of strings, default `['childManifestUrl', 'filters', 'pages', 'pan', 'rotation', 'view', 'zoom']`

	The parameter keys to be read from and stored in the URL query. Only has effect if `urlQueryKey` is set, in which case parameters read from the URL override options of the same name.

	The initially displayed view (panel); `scan`, `fulltext`, `thumbnails`, `toc`, `info`, `help`, or empty (same as `scan`). On large screens, the scan is always shown next to the selected view.

	An object with options for OpenSeadragon, TIFY’s image rendering component. [See its documentation](https://openseadragon.github.io/docs/OpenSeadragon.html#.Options) for all available options.

- **`zoom`**: floating-point number, default `null`

	Sets the initial zoom level. The higher the number, the deeper the zoom. By default, zoom is set automatically so that the full image is visible.

An example with most available options set to non-default values:

		{
		"name": "tify",
		"version": "0.28.0",
		"version": "0.28.1",
		"description": "TIFY is a slim and mobile-friendly IIIF document viewer.",
		@@ -5,0 +5,0 @@ "homepage": "https://tify.rocks/",

Fixed alerts

Improved metrics

		@@ -26,7 +26,7 @@ <h1>
		``` html
		<script src="tify.js?v0.28.0"></script>
		<link rel="stylesheet" href="tify.css?v0.28.0">
		<script src="tify.js?v0.28.1"></script>
		<link rel="stylesheet" href="tify.css?v0.28.1">
		```

		> To avoid issues with browser caching, add a query parameter with the current version, e.g. `?v0.28.0`.
		> To avoid issues with browser caching, add a query parameter with the current version, e.g. `?v0.28.1`.

		@@ -36,4 +36,4 @@ - Or use [jsDelivr](https://www.jsdelivr.com/):
		``` html
		<script src="https://cdn.jsdelivr.net/npm/tify@0.28.0/dist/tify.js"></script>
		<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/tify@0.28.0/dist/tify.css">
		<script src="https://cdn.jsdelivr.net/npm/tify@0.28.1/dist/tify.js"></script>
		<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/tify@0.28.1/dist/tify.css">
		```
		@@ -40,0 +40,0 @@