diff --git a/.github/workflows/publish-pages.yml b/.github/workflows/publish-pages.yml index c507903..0ec93a9 100644 --- a/.github/workflows/publish-pages.yml +++ b/.github/workflows/publish-pages.yml @@ -29,8 +29,8 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 - - uses: actions/setup-node@v3 + uses: actions/checkout@v4 + - uses: actions/setup-node@v4 with: node-version: '18.x' registry-url: 'https://registry.npmjs.org' @@ -39,11 +39,11 @@ jobs: npm install npm run build - name: Setup Pages - uses: actions/configure-pages@v3 + uses: actions/configure-pages@v4 - name: Upload artifact - uses: actions/upload-pages-artifact@v1 + uses: actions/upload-pages-artifact@v3 with: - path: 'dist' + path: 'build' - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v2 + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/test-on-pull.yml b/.github/workflows/test-on-pull.yml index df83226..d6e1a64 100644 --- a/.github/workflows/test-on-pull.yml +++ b/.github/workflows/test-on-pull.yml @@ -10,8 +10,8 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 - - uses: actions/setup-node@v3 + uses: actions/checkout@v4 + - uses: actions/setup-node@v4 with: node-version: '18.x' registry-url: 'https://registry.npmjs.org' 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 7b379c6..8897bbf 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ FSI Viewer 360 can be created and controlled as a simple HTML tag and/or through 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 e8e1a60..142444d 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "name": "NeptuneLabs GmbH", "url": "https://www.neptunelabs.com/" }, - "version": "23.11.24", + "version": "24.03.19", "homepage": "https://www.neptunelabs.com/fsi-viewer-360", "repository": { "type": "git", @@ -12,15 +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" }, - "devDependencies": { - "@neptunelabs/fsi-samples-framework": "^1.1.0", - "prettier": "^3.0.1" + "dependencies": { + "@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 f62b513..47e3ca7 100644 --- a/project.yml +++ b/project.yml @@ -2,5 +2,6 @@ title: 'FSI Viewer 360°' projectURL: https://www.neptunelabs.com/fsi-viewer-360/ originAssetPath: viewer-360 +schema: overview-taupe playground: stackblitz: fsi-viewer-360-samples diff --git a/samples/javascript-api/README.md b/samples/javascript-api/README.md new file mode 100644 index 0000000..6a02ce1 --- /dev/null +++ b/samples/javascript-api/README.md @@ -0,0 +1,103 @@ +# 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 a spin with FSI Viewer, all you need to do is add the following script to the top of your web page: + +```html +