published 2.2.3 w/addition of options.interaction

davidfig · Jan 31, 2021 · 62db8a8 · 62db8a8
1 parent 13c3464
commit 62db8a8
Show file tree

Hide file tree

Showing 13 changed files with 58 additions and 19 deletions.
diff --git a/dist/scrollbox.es.js b/dist/scrollbox.es.js
diff --git a/dist/scrollbox.es.js.map b/dist/scrollbox.es.js.map
diff --git a/dist/scrollbox.js b/dist/scrollbox.js
diff --git a/dist/scrollbox.js.map b/dist/scrollbox.js.map
diff --git a/docs/index.js b/docs/index.js
@@ -50337,6 +50337,7 @@
 	     * @param {(string|function)} [options.fadeScrollboxEase=easeInOutSine] easing function to use for fading
 	     * @param {boolean} [options.passiveWheel=false] whether wheel events are propogated beyond the scrollbox (NOTE: default is now false)
 	     * @param {boolean} [options.clampWheel=true] wheel events should be clamped (to avoid weird bounce with mouse wheel)
+	     * @param {PIXI.InteractionManager} [options.interaction] InteractionManager, available from instantiated PIXI.Renderer.plugins.interaction - used to calculate pointer postion relative to canvas location on screen
 	     */
 	    constructor(options={})
 	    {
@@ -50352,7 +50353,7 @@
 	         * you can use any function from pixi-viewport on content to manually move the content (see https://davidfig.github.io/pixi-viewport/jsdoc/)
 	         * @type {Viewport}
 	         */
-	        this.content = this.addChild(new Viewport({ passiveWheel: this.options.passiveWheel, stopPropagation: this.options.stopPropagation, screenWidth: this.options.boxWidth, screenHeight: this.options.boxHeight }));
+	        this.content = this.addChild(new Viewport({ passiveWheel: this.options.passiveWheel, stopPropagation: this.options.stopPropagation, screenWidth: this.options.boxWidth, screenHeight: this.options.boxHeight, interaction: this.options.interaction }));
 	        this.content
 	            .decelerate()
 	            .on('moved', () => this._drawScrollbars());

diff --git a/docs/index.js.map b/docs/index.js.map
diff --git a/docs/jsdoc/EventEmitter-.html b/docs/jsdoc/EventEmitter-.html
@@ -275,7 +275,7 @@ <h4 class="name" id="EventEmitter">
 
         <footer class="content-size">
             <div class="footer">
-                Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Tue Dec 01 2020 08:19:59 GMT+0800 (Taipei Standard Time)
+                Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon Feb 01 2021 06:56:03 GMT+0800 (Taipei Standard Time)
             </div>
         </footer>
     </div>

diff --git a/docs/jsdoc/Scrollbox.html b/docs/jsdoc/Scrollbox.html
@@ -1089,6 +1089,40 @@ <h4 class="name" id="Scrollbox">
         </tr>
 
 
+
+        <tr>
+
+                <td class="name"><code>interaction</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">PIXI.InteractionManager</span>
+
+
+
+            </td>
+
+
+                <td class="default">
+
+                </td>
+
+
+            <td class="description last">
+
+
+                        <span class="optional">optional</span>
+
+
+
+
+
+                <p>InteractionManager, available from instantiated PIXI.Renderer.plugins.interaction - used to calculate pointer postion relative to canvas location on screen</p></td>
+        </tr>
+
+
 	</tbody>
 </table>
             </td>
@@ -2317,7 +2351,7 @@ <h4 class="name" id="activateFade">
 
 
         <div class="tag-source">
-            <a href="src_scrollbox.js.html#line533">scrollbox.js:533</a>
+            <a href="src_scrollbox.js.html#line534">scrollbox.js:534</a>
         </div>
 
     </div>
@@ -2393,7 +2427,7 @@ <h4 class="name" id="ensureVisible">
 
 
         <div class="tag-source">
-            <a href="src_scrollbox.js.html#line682">scrollbox.js:682</a>
+            <a href="src_scrollbox.js.html#line683">scrollbox.js:683</a>
         </div>
 
     </div>
@@ -2583,7 +2617,7 @@ <h4 class="name" id="resize">
 
 
         <div class="tag-source">
-            <a href="src_scrollbox.js.html#line659">scrollbox.js:659</a>
+            <a href="src_scrollbox.js.html#line660">scrollbox.js:660</a>
         </div>
 
     </div>
@@ -2846,7 +2880,7 @@ <h4 class="name" id="update">
 
 
         <div class="tag-source">
-            <a href="src_scrollbox.js.html#line464">scrollbox.js:464</a>
+            <a href="src_scrollbox.js.html#line465">scrollbox.js:465</a>
         </div>
 
     </div>
@@ -2922,7 +2956,7 @@ <h4 class="name" id="updateLoop">
 
 
         <div class="tag-source">
-            <a href="src_scrollbox.js.html#line487">scrollbox.js:487</a>
+            <a href="src_scrollbox.js.html#line488">scrollbox.js:488</a>
         </div>
 
     </div>
@@ -3045,7 +3079,7 @@ <h4 class="name" id="updateLoop">
 
         <footer class="content-size">
             <div class="footer">
-                Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Tue Dec 01 2020 08:19:59 GMT+0800 (Taipei Standard Time)
+                Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon Feb 01 2021 06:56:03 GMT+0800 (Taipei Standard Time)
             </div>
         </footer>
     </div>

diff --git a/docs/jsdoc/index.html b/docs/jsdoc/index.html
@@ -239,7 +239,7 @@ <h2>license</h2>
 
         <footer class="content-size">
             <div class="footer">
-                Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Tue Dec 01 2020 08:19:59 GMT+0800 (Taipei Standard Time)
+                Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon Feb 01 2021 06:56:03 GMT+0800 (Taipei Standard Time)
             </div>
         </footer>
     </div>

diff --git a/docs/jsdoc/node_modules_eventemitter3_index.js.html b/docs/jsdoc/node_modules_eventemitter3_index.js.html
@@ -506,7 +506,7 @@ <h2>node_modules/eventemitter3/index.js</h2>
 
         <footer class="content-size">
             <div class="footer">
-                Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Tue Dec 01 2020 08:19:59 GMT+0800 (Taipei Standard Time)
+                Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon Feb 01 2021 06:56:03 GMT+0800 (Taipei Standard Time)
             </div>
         </footer>
     </div>

diff --git a/docs/jsdoc/node_modules_eventemitter3_umd_eventemitter3.js.html b/docs/jsdoc/node_modules_eventemitter3_umd_eventemitter3.js.html
@@ -510,7 +510,7 @@ <h2>node_modules/eventemitter3/umd/eventemitter3.js</h2>
 
         <footer class="content-size">
             <div class="footer">
-                Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Tue Dec 01 2020 08:19:59 GMT+0800 (Taipei Standard Time)
+                Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon Feb 01 2021 06:56:03 GMT+0800 (Taipei Standard Time)
             </div>
         </footer>
     </div>

diff --git a/docs/jsdoc/src_scrollbox.js.html b/docs/jsdoc/src_scrollbox.js.html
@@ -213,6 +213,7 @@ <h2>src/scrollbox.js</h2>
      * @param {(string|function)} [options.fadeScrollboxEase=easeInOutSine] easing function to use for fading
      * @param {boolean} [options.passiveWheel=false] whether wheel events are propogated beyond the scrollbox (NOTE: default is now false)
      * @param {boolean} [options.clampWheel=true] wheel events should be clamped (to avoid weird bounce with mouse wheel)
+     * @param {PIXI.InteractionManager} [options.interaction] InteractionManager, available from instantiated PIXI.Renderer.plugins.interaction - used to calculate pointer postion relative to canvas location on screen
      */
     constructor(options={})
     {
@@ -228,7 +229,7 @@ <h2>src/scrollbox.js</h2>
          * you can use any function from pixi-viewport on content to manually move the content (see https://davidfig.github.io/pixi-viewport/jsdoc/)
          * @type {Viewport}
          */
-        this.content = this.addChild(new Viewport({ passiveWheel: this.options.passiveWheel, stopPropagation: this.options.stopPropagation, screenWidth: this.options.boxWidth, screenHeight: this.options.boxHeight }))
+        this.content = this.addChild(new Viewport({ passiveWheel: this.options.passiveWheel, stopPropagation: this.options.stopPropagation, screenWidth: this.options.boxWidth, screenHeight: this.options.boxHeight, interaction: this.options.interaction }))
         this.content
             .decelerate()
             .on('moved', () => this._drawScrollbars())
@@ -843,7 +844,8 @@ <h2>src/scrollbox.js</h2>
         this.content.ensureVisible(x, y, width, height)
         this._drawScrollbars()
     }
-}</code></pre>
+}
+</code></pre>
         </article>
     </section>
 
@@ -856,7 +858,7 @@ <h2>src/scrollbox.js</h2>
 
         <footer class="content-size">
             <div class="footer">
-                Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Tue Dec 01 2020 08:19:59 GMT+0800 (Taipei Standard Time)
+                Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon Feb 01 2021 06:56:03 GMT+0800 (Taipei Standard Time)
             </div>
         </footer>
     </div>

diff --git a/src/scrollbox.js b/src/scrollbox.js
@@ -54,6 +54,7 @@ export class Scrollbox extends PIXI.Container
      * @param {(string|function)} [options.fadeScrollboxEase=easeInOutSine] easing function to use for fading
      * @param {boolean} [options.passiveWheel=false] whether wheel events are propogated beyond the scrollbox (NOTE: default is now false)
      * @param {boolean} [options.clampWheel=true] wheel events should be clamped (to avoid weird bounce with mouse wheel)
+     * @param {PIXI.InteractionManager} [options.interaction] InteractionManager, available from instantiated PIXI.Renderer.plugins.interaction - used to calculate pointer postion relative to canvas location on screen
      */
     constructor(options={})
     {