diff --git a/.gitignore b/.gitignore index af82236..353e775 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ yarn.lock node_modules dist +build .cache env.yml diff --git a/README.md b/README.md index 9dcd90f..5be1bdf 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,12 @@ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)][License] -The JavaScript-based viewer provides a minimalist, highly customisable user interface that is easily adaptable via CSS, supported by lightning-fast real-time image delivery from the FSI Server. +The zoom viewer provides a minimalist, highly customisable user interface that is easily adaptable via CSS, supported by lightning-fast real-time image delivery from the FSI Server. FSI Viewer can be created and controlled as a simple HTML tag and/or via the JavaScript API. This repository contains examples on how to use and build your own applications. -![Project Image](project.apng) +[![Project Image](project.apng)][GHPages] ## Getting Started diff --git a/package.json b/package.json index b857934..aca87bd 100644 --- a/package.json +++ b/package.json @@ -3,8 +3,8 @@ "name": "NeptuneLabs GmbH", "url": "https://www.neptunelabs.com/" }, - "version": "23.11.24", - "homepage": "https://www.neptunelabs.com/fsi-viewer", + "version": "24.03.19", + "homepage": "https://neptunelabs.com/fsi-viewer", "repository": { "type": "git", "url": "https://github.com/neptunelabs/fsi-viewer-samples" @@ -12,17 +12,14 @@ "license": "Apache-2.0", "private": true, "engines": { - "node": ">=16.0.0", - "npm": ">=6.0.0" + "node": ">=18.0.0", + "npm": ">=8.0.0" }, "dependencies": { - "@neptunelabs/fsi-samples-framework": "^1.1.0" - }, - "devDependencies": { - "prettier": "^3.0.1" + "@neptunelabs/fsi-samples-framework": "^2.0.18" }, "scripts": { - "start": "start-sample", - "build": "start-sample --build" + "start": "workbench", + "build": "workbench --build" } } diff --git a/project.yml b/project.yml index 4f1279f..b0022af 100644 --- a/project.yml +++ b/project.yml @@ -2,5 +2,6 @@ title: 'FSI Viewer' projectURL: https://www.neptunelabs.com/fsi-viewer/ originAssetPath: viewer +schema: overview-taupe playground: stackblitz: fsi-viewer-samples diff --git a/samples/custom-product-detail-page/config.yml b/samples/custom-product-detail-page/config.yml index 8773f01..abe7737 100644 --- a/samples/custom-product-detail-page/config.yml +++ b/samples/custom-product-detail-page/config.yml @@ -7,29 +7,20 @@ overview: - JS built FSI Viewer - zoom and pan - custom UI +schema: bootstrap-taupe sample: - template: - schema: framework-2023 - components: - menu: - template: data/misc-menu.yml - hero: false - featured: true - footer: - credits: - photos: - - author: Brandon Atchison - link: https://unsplash.com/@b_atchison98?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText - platform: Unsplash - viewer: - link: https://www.neptunelabs.com/fsi-viewer/ - fsi: - viewer: true - bootstrap: - icons: false - mapping: - html: "index.html" - css: "style.css" - js: "script.js" -playground: - deploy: true + menu: + data: misc-menu.yml + featured: true + footer: + credits: + photos: + - author: Brandon Atchison + link: https://unsplash.com/@b_atchison98?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText + platform: Unsplash + viewer: + link: https://www.neptunelabs.com/fsi-viewer/ + fsi: + viewer: true + bootstrap: + icons: false diff --git a/samples/custom-product-detail-page/index.html b/samples/custom-product-detail-page/container.html similarity index 100% rename from samples/custom-product-detail-page/index.html rename to samples/custom-product-detail-page/container.html diff --git a/samples/external-buttons/config.yml b/samples/external-buttons/config.yml index 63392c3..4180638 100644 --- a/samples/external-buttons/config.yml +++ b/samples/external-buttons/config.yml @@ -7,32 +7,24 @@ overview: - JS built FSI Viewer - external UI - zoom and pan +schema: bootstrap-taupe sample: - template: - schema: framework-2023 - components: - menu: - template: data/clothing-menu.yml - featured: - template: data/clothing-featured.yml - highlight: DEAL OF THE DAY - footer: - credits: - photos: - - author: Kate Skumen - link: https://unsplash.com/@skumen?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText - platform: Unsplash - viewer: - link: https://www.neptunelabs.com/fsi-viewer/ - hero: false - fsi: - viewer: true - bootstrap: - icons: true - jquery: true - mapping: - html: "index.html" - css: "style.css" - js: "script.js" -playground: - deploy: true + menu: + data: clothing-menu.yml + featured: + data: clothing-featured.yml + highlight: DEAL OF THE DAY + footer: + credits: + photos: + - author: Kate Skumen + link: https://unsplash.com/@skumen?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText + platform: Unsplash + viewer: + link: https://www.neptunelabs.com/fsi-viewer/ + hero: false + fsi: + viewer: true + bootstrap: + icons: true + diff --git a/samples/external-buttons/index.html b/samples/external-buttons/container.html similarity index 100% rename from samples/external-buttons/index.html rename to samples/external-buttons/container.html diff --git a/samples/external-slider/config.yml b/samples/external-slider/config.yml index 08f1e51..80e9554 100644 --- a/samples/external-slider/config.yml +++ b/samples/external-slider/config.yml @@ -7,35 +7,27 @@ overview: - JS built FSI Viewer - external slider - zoom and pan +schema: bootstrap-taupe sample: - template: - schema: framework-2023 - components: - menu: - template: data/misc-menu.yml - highlight: DEAL OF THE DAY - featured: true - footer: - credits: - photos: - - author: Jonny Caspari - link: https://unsplash.com/@jonnysplsh?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText - platform: Unsplash - - author: max fuchs - link: https://unsplash.com/@designfuchs?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText - platform: Unsplash - - author: William Moreland - link: https://unsplash.com/@relentlessjpg?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText - platform: Unsplash - viewer: - link: https://www.neptunelabs.com/fsi-viewer/ - fsi: - viewer: true - bootstrap: - icons: false - mapping: - html: "index.html" - css: "style.css" - js: "script.js" -playground: - deploy: true + menu: + data: misc-menu.yml + highlight: DEAL OF THE DAY + featured: true + footer: + credits: + photos: + - author: Jonny Caspari + link: https://unsplash.com/@jonnysplsh?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText + platform: Unsplash + - author: max fuchs + link: https://unsplash.com/@designfuchs?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText + platform: Unsplash + - author: William Moreland + link: https://unsplash.com/@relentlessjpg?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText + platform: Unsplash + viewer: + link: https://www.neptunelabs.com/fsi-viewer/ + fsi: + viewer: true + bootstrap: + icons: false diff --git a/samples/external-slider/index.html b/samples/external-slider/container.html similarity index 100% rename from samples/external-slider/index.html rename to samples/external-slider/container.html diff --git a/samples/javascript-api/README.md b/samples/javascript-api/README.md new file mode 100644 index 0000000..ce1b345 --- /dev/null +++ b/samples/javascript-api/README.md @@ -0,0 +1,110 @@ +# JS API Sample + +FSI Viewer contains an extensive JS API with methods and callbacks that you can use. +You can find [an overview of all available parameters in the corresponding documentation](https://docs.neptunelabs.com/docs/fsi-viewer/js-api/public-methods). + +This example is a simple demonstration of how to use these methods and callbacks. + +To display zoom with FSI Viewer, all you need to do is add the following script to the top of your web page: + +```html +