Release 4.0.2

mistic100 · Apr 29, 2020 · 2ad1073 · 2ad1073
2 parents 41b3bda + 59b7078
commit 2ad1073
Show file tree

Hide file tree

Showing 30 changed files with 81 additions and 41 deletions.
diff --git a/.jsdoc.json b/.jsdoc.json
@@ -6,11 +6,12 @@
     "recurse": true,
     "private": false,
     "template": "node_modules/@pixi/jsdoc-template",
-    "readme": "docs/jsdoc.md"
+    "readme": "docs/.jsdoc/index.md"
   },
   "plugins": [
     "plugins/markdown",
-    "@pixi/jsdoc-template/plugins/es6-fix"
+    "@pixi/jsdoc-template/plugins/es6-fix",
+    "docs/.jsdoc/cleanup-exports"
   ],
   "templates": {
     "applicationName": "Photo Sphere Viewer",

diff --git a/dist/photo-sphere-viewer.css b/dist/photo-sphere-viewer.css
diff --git a/dist/photo-sphere-viewer.css.map b/dist/photo-sphere-viewer.css.map
diff --git a/dist/photo-sphere-viewer.js b/dist/photo-sphere-viewer.js
diff --git a/dist/photo-sphere-viewer.js.map b/dist/photo-sphere-viewer.js.map
diff --git a/dist/plugins/autorotate-keypoints.js b/dist/plugins/autorotate-keypoints.js
diff --git a/dist/plugins/gyroscope.js b/dist/plugins/gyroscope.js
diff --git a/dist/plugins/markers.css b/dist/plugins/markers.css
diff --git a/dist/plugins/markers.css.map b/dist/plugins/markers.css.map
diff --git a/dist/plugins/markers.js b/dist/plugins/markers.js
diff --git a/dist/plugins/markers.js.map b/dist/plugins/markers.js.map
diff --git a/dist/plugins/stereo.js b/dist/plugins/stereo.js
diff --git a/dist/plugins/visible-range.js b/dist/plugins/visible-range.js
diff --git a/dist/viewer-compat.js b/dist/viewer-compat.js
diff --git a/docs/.jsdoc/cleanup-exports.js b/docs/.jsdoc/cleanup-exports.js
@@ -0,0 +1,10 @@
+exports.handlers = {
+  newDoclet: function (e) {
+    e.doclet.name = e.doclet.name.replace('exports.', '');
+    e.doclet.longname = e.doclet.longname.replace('exports.', '');
+
+    if (typeof e.doclet.meta.code.name === 'string') {
+      e.doclet.meta.code.name = e.doclet.meta.code.name.replace('exports.', '');
+    }
+  },
+};
diff --git a/docs/jsdoc.md → docs/.jsdoc/index.md b/docs/jsdoc.md → docs/.jsdoc/index.md
@@ -2,9 +2,9 @@
 
 # [← Main documentation](..)
 
-# [Primary class](PSV.Viewer.html)
+# [Viewer](PSV.Viewer.html)
 
-# [List of events](PSV.html#.event:autorotate)
+# [Events](PSV.html#.event:autorotate)
 
 # [Plugins](PSV.plugins.html)
 
@@ -15,10 +15,10 @@
 - [AbstractButton](PSV.buttons.AbstractButton.html)
 - [AbstractPlugin](PSV.plugins.AbstractPlugin.html)
 - [Animation](PSV.Animation.html)
-- [CONSTANTS](PSV.CONSTANTS.html)
-- [DEFAULTS](PSV.html#.exports.DEFAULTS)
+- CONSTANTS
+- [DEFAULTS](PSV.html#.DEFAULTS)
 - [PSVError](PSV.PSVError.html)
-- [registerButton](PSV.html#.exports.registerButton)
-- [SYSTEM](PSV.html#.exports.SYSTEM)
+- [registerButton](PSV.html#.registerButton)
+- [SYSTEM](PSV.html#.SYSTEM)
 - [Viewer](PSV.Viewer.html)
 - [utils](PSV.utils.html)
diff --git a/docs/.vuepress/components/ApiButton.vue b/docs/.vuepress/components/ApiButton.vue
@@ -0,0 +1,12 @@
+<template>
+  <md-button class="md-raised md-primary" v-bind:href="href" target="_blank">
+    API Documentation
+    <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="white" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="white" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
+  </md-button>
+</template>
+
+<script>
+  export default {
+    props: ['href'],
+  };
+</script>
diff --git a/docs/.vuepress/plugins/version-mixin.js b/docs/.vuepress/plugins/version-mixin.js
@@ -2,7 +2,7 @@ export default {
   mounted () {
     setTimeout(() => {
       const titleElt = document.querySelector('.site-name');
-      titleElt.innerHTML+= ` <small class="md-badge md-primary md-square md-theme-default">4.0.0</small>`;
+      titleElt.innerHTML+= ` <small class="md-badge md-primary md-square md-theme-default">4.0.1</small>`;
     });
   }
 }
diff --git a/docs/.vuepress/public/_headers b/docs/.vuepress/public/_headers
@@ -0,0 +1,2 @@
+/assets/*
+  Access-Control-Allow-Origin: *
diff --git a/docs/plugins/plugin-autorotate-keypoints.md b/docs/plugins/plugin-autorotate-keypoints.md
@@ -1,6 +1,6 @@
 # AutorotateKeypointsPlugin
 
-<md-button class="md-raised md-primary" href="https://photo-sphere-viewer.js.org/api/PSV.plugins.AutorotateKeypointsPlugin.html">API Documentation</md-button>
+<ApiButton href="https://photo-sphere-viewer.js.org/api/PSV.plugins.AutorotateKeypointsPlugin.html"/>
 
 > Replaces the standard autorotate animation by a smooth transition between multiple points.
 

diff --git a/docs/plugins/plugin-gyroscope.md b/docs/plugins/plugin-gyroscope.md
@@ -1,6 +1,6 @@
 # GyroscopePlugin
 
-<md-button class="md-raised md-primary" href="https://photo-sphere-viewer.js.org/api/PSV.plugins.GyroscopePlugin.html">API Documentation</md-button>
+<ApiButton href="https://photo-sphere-viewer.js.org/api/PSV.plugins.GyroscopePlugin.html"/>
 
 > Adds gyroscope controls on mobile devices.
 

diff --git a/docs/plugins/plugin-markers.md b/docs/plugins/plugin-markers.md
@@ -75,7 +75,7 @@ Size of the marker.
 _(This option is ignored for polygons and polylines)_
 
 #### `scale`
-- type : 'double | double[]'
+- type : `double | double[]`
 
 Scale factor multiplied by the zoom level. Provide an array of two values for min and max.
 By default the scale is constant.

diff --git a/docs/plugins/plugin-stereo.md b/docs/plugins/plugin-stereo.md
@@ -1,6 +1,6 @@
 # StereoPlugin
 
-<md-button class="md-raised md-primary" href="https://photo-sphere-viewer.js.org/api/PSV.plugins.StereoPlugin.html">API Documentation</md-button>
+<ApiButton href="https://photo-sphere-viewer.js.org/api/PSV.plugins.StereoPlugin.html"/>
 
 > Adds stereo view on mobile devices. **Requires the Gyroscope plugin.**
 

diff --git a/docs/plugins/plugin-visible-range.md b/docs/plugins/plugin-visible-range.md
@@ -1,6 +1,6 @@
 # VisibleRangePlugin
 
-<md-button class="md-raised md-primary" href="https://photo-sphere-viewer.js.org/api/PSV.plugins.VisibleRangePlugin.html">API Documentation</md-button>
+<ApiButton href="https://photo-sphere-viewer.js.org/api/PSV.plugins.VisibleRangePlugin.html"/>
 
 > Locks visible longitude and/or latitude.
 

diff --git a/example/plugin-markers.html b/example/plugin-markers.html
@@ -80,7 +80,7 @@ <h3>Header Level 3</h3>
     <li>Aliquam tincidunt mauris eu risus.</li>
   </ul>
 
-  <img src="assets/pin2.png" style="width:100%"/>
+  <img src="assets/pin-blue.png" style="width:100%"/>
 
   <pre><code>
 #header h1 a {
@@ -228,7 +228,7 @@ <h3>Header Level 3</h3>
 
           a.push({
             id       : 'text',
-            html     : 'This <b>is</b> text <img src="assets/pin3.png" style="height: 24px; vertical-align: top;"/>',
+            html     : 'This <b>is</b> text <img src="assets/pin-blue.png" style="height: 24px; vertical-align: top;"/>',
             anchor   : 'bottom right',
             style    : {
               color     : 'white',