TypeScript icon, indicating that this package has built-in type declarations

    1.3.0 • Public • Published

    Built With Stencil Maintenance NPM version Downloads TotalDownloads Twitter Follow


    Web Component built with Stencil.js to integrate Phaser with any other framework.


    Inspired by the old IonPhaser directive


    Do you want to see this web component in action? Visit https://codepen.io/jdnichollsc/full/oRrwKM yay! 🎉

    IonPhaser CE

    Looking for Phaser Framework CE (Community Edition)? Check here!

    Getting Started


    Project Package Version Links
    Core @ion-phaser/core version README.md
    React @ion-phaser/react version README.md

    Script tag

    • Put a script tag similar to this <script src='https://unpkg.com/@ion-phaser/core@1.3.0/dist/ionphaser.js'></script> in the head of your index.html
    • Then you can use the element anywhere in your template, JSX, html etc

    Node Modules

    • Run npm install @ion-phaser/core --save
    • Put a script tag similar to this <script src='node_modules/@ion-phaser/core/dist/ionphaser.js'></script> in the head of your index.html
    • Then you can use the element anywhere in your template, JSX, html etc

    In a stencil-starter app

    • Run npm install @ion-phaser/core --save
    • Add an import to the npm packages import @ion-phaser/core;
    • Then you can use the element anywhere in your template, JSX, html etc


    Simply add this tag wherever you want in your project:

    <ion-phaser [game]="game"></ion-phaser>

    These properties are available on the component:

    • game (required)
    • initialize (optional)

    Framework integrations


    Using ion-phaser component within an Angular project:

    Including the Custom Elements Schema

    Including the CUSTOM_ELEMENTS_SCHEMA in the module allows the use of Web Components in the HTML files. Here is an example of adding it to AppModule:

    import { BrowserModule } from '@angular/platform-browser';
    import { CUSTOM_ELEMENTS_SCHEMA, NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
      declarations: [AppComponent],
      imports: [BrowserModule],
      bootstrap: [AppComponent],
    export class AppModule {}

    The CUSTOM_ELEMENTS_SCHEMA needs to be included in any module that uses IonPhaser.

    Calling defineCustomElements

    IonPhaser component includes a function used to load itself in the application window object. That function is called defineCustomElements() and needs to be executed once during the bootstrapping of your application. One convenient place to add it is in the main.ts file as follows:

    import { enableProdMode } from '@angular/core';
    import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
    import { defineCustomElements as defineIonPhaser } from '@ion-phaser/core/loader';
    import { AppModule } from './app/app.module';
    import { environment } from './environments/environment';
    if (environment.production) {
      .catch(err => console.log(err));

    Using IonPhaser in an Angular component

    public game = {
      width?: integer | string;
      height?: integer | string;
      zoom?: number;
      resolution?: number;
      type?: number;
      parent: HTMLElement | string;
      canvas?: HTMLCanvasElement;
      canvasStyle?: string;
      context?: CanvasRenderingContext2D;
      scene?: object;
      seed?: string[];
      title?: string;
      url?: string;
      version?: string;
      autoFocus?: boolean;
      input?: boolean | InputConfig;
      disableContextMenu?: boolean;
      banner?: boolean | BannerConfig;
      dom?: DOMContainerConfig;
      fps?: FPSConfig;
      render?: RenderConfig;
      backgroundColor?: string | number;
      callbacks?: CallbacksConfig;
      loader?: LoaderConfig;
      images?: ImagesConfig;
      physics?: object;
      plugins?: PluginObject | PluginObjectItem[];
      scale?: ScaleConfig;,
      instance: Game // It's created internally when the game is initialized
    public initialize: boolean;
    constructor(private api : ApiService){}
    initializeGame() {
      this.game = {
        width: "100%",
        height: "100%",
        type: Phaser.AUTO,
        scene: {}
      this.initialize = true
      return this.game.instance

    from stencil documentation


    Specific Wrapper

    When using a wrapper component, It's not necessary to access the reference directly to configure the game. More details here.

    import React, { Component } from 'react'
    import Phaser from 'phaser'
    import { IonPhaser } from '@ion-phaser/react'
    class App extends Component {
      state = {
        initialize: false,
        game: {
          width: "100%",
          height: "100%",
          type: Phaser.AUTO,
          scene: {}
      render() {
        const { initialize, game } = this.state
        return (
          <IonPhaser game={game} initialize={initialize} />

    Web Component

    Other option is using the web component directly:

    import React from 'react'
    import ReactDOM from 'react-dom'
    import { defineCustomElements as defineIonPhaser } from '@ion-phaser/core/loader'
    import Phaser from 'phaser'
    const game = {
      width: "100%",
      height: "100%",
      type: Phaser.AUTO,
      scene: {}
    ReactDOM.render(<ion-phaser ref={el => el.game = game} />, document.getElementById('root'));

    from stencil documentation


    In order to use the ion-phaser Web Component inside of a Vue application, it should be modified to define the custom elements and to inform the Vue compiler which elements to ignore during compilation. This can all be done within the main.js file as follows:

    import Vue from 'vue';
    import { defineCustomElements as defineIonPhaser } from '@ion-phaser/core/loader'
    import App from './App.vue';
    Vue.config.productionTip = false;
    Vue.config.ignoredElements = [/ion-\w*/];
    // Bind the IonPhaser custom element to the window object
    new Vue({
      render: h => h(App)

    Using IonPhaser in a Vue component

    import Phaser from 'phaser'
    export default {
      name: 'HelloWorld',
      data() {
        return {
          initialize: false,
          game: {
            width: "100%",
            height: "100%",
            type: Phaser.AUTO,
            scene: {
              init: function() {
              create: function() {
                this.helloWorld = this.add.text(
                  "Hello World", { 
                    font: "40px Arial", 
                    fill: "#ffffff" 
              update: function() {
                this.helloWorld.angle += 1;

    from stencil documentation


    When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
    Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated ❤️.
    You can learn more about how you can contribute to this project in the contribution guide.

    Supporting 🍻

    I believe in Unicorns 🦄 Support me, if you do too.

    Enterprise 💼

    Available as part of the Tidelift Subscription.

    The maintainers of IonPhaser and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

    Security contact information 🚨

    To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

    License ⚖️

    This repository is available under the MIT License.

    Happy coding 💯

    Made with ❤️


    npm i @ion-phaser/core

    DownloadsWeekly Downloads






    Unpacked Size

    279 kB

    Total Files


    Last publish


    • jdnichollsc