@pixi/events - npm Package Compare versions

Comparing version 6.5.6 to 6.5.7

dist/browser/events.min.js

 /*!
- * @pixi/events - v6.5.6
- * Compiled Tue, 11 Oct 2022 18:23:26 UTC
+ * @pixi/events - v6.5.7
+ * Compiled Thu, 20 Oct 2022 15:13:33 UTC
  *
@@ -5,0 +5,0 @@ * @pixi/events is licensed under the MIT License.

dist/cjs/events.min.js

 /*!
- * @pixi/events - v6.5.6
- * Compiled Tue, 11 Oct 2022 18:23:26 UTC
+ * @pixi/events - v6.5.7
+ * Compiled Thu, 20 Oct 2022 15:13:33 UTC
  *
@@ -5,0 +5,0 @@ * @pixi/events is licensed under the MIT License.

index.d.ts

@@ -402,2 +402,51 @@ /// <reference path="./global.d.ts" />
  * The system for handling UI events.
+ *
+ * ### Setup
+ *
+ * As for PixiJS v6.x, `@pixi/events` is an opt-in package, so you need to import it first.
+ *
+ * #### NPM Install
+ *
+ * ```sh
+ * npm install @pixi/events@v6.x
+ * ```
+ *
+ * There is no default export. The correct way to import EventSystem is:
+ *
+ * ```js
+ * import { Application, Renderer } from 'pixi.js';
+ * import { EventSystem } from '@pixi/events';
+ *
+ * // Disable interaction plugin (for PixiJS v6.x)
+ * delete Renderer.__plugins.interaction;
+ *
+ * const app = new Application();
+ * app.renderer.addSystem(EventSystem, 'events');
+ * ```
+ *
+ * #### CDN Install
+ *
+ * Via jsDelivr:
+ *
+ * ```html
+ * <script src="https://cdn.jsdelivr.net/npm/@pixi/events@6.x/dist/browser/events.min.js"></script>
+ * ```
+ *
+ * Or via unpkg:
+ *
+ * ```html
+ * <script src="https://unpkg.com/@pixi/events@6.x/dist/browser/events.min.js"></script>
+ * ```
+ *
+ * Then install the EventSystem:
+ *
+ * ```js
+ * // Disable interaction plugin (for PixiJS v6.x)
+ * delete PIXI.Renderer.__plugins.interaction;
+ *
+ * const app = new PIXI.Application();
+ * app.renderer.addSystem(PIXI.EventSystem, 'events');
+ * ```
+ *
+ * _Note: The version of `@pixi/events` should be the same as the version of `pixi.js` you are using._
  * @memberof PIXI
@@ -404,0 +453,0 @@ */

package.json

 {
   "name": "@pixi/events",
-  "version": "6.5.6",
+  "version": "6.5.7",
   "main": "dist/cjs/events.js",
@@ -48,7 +48,7 @@ "module": "dist/esm/events.mjs",
   "peerDependencies": {
-    "@pixi/display": "6.5.6",
-    "@pixi/math": "6.5.6",
-    "@pixi/utils": "6.5.6"
+    "@pixi/display": "6.5.7",
+    "@pixi/math": "6.5.7",
+    "@pixi/utils": "6.5.7"
   },
-  "gitHead": "da6a98f2c6f861f68fb4d440974f88dd8542e139"
+  "gitHead": "1a174ba411187720da4ce536c90403004e4253dd"
 }

No alert changes

Improved metrics

Total package byte prevSize

1498957

increased by0.86%

Lines of code

8747

increased by2.29%

No dependency changes