npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

excalibur-ui

v0.0.0-4

Published

A UI library for Excalibur.js

Downloads

5

Readme

excalibur-ui

⚠️ very much a work in progress ⚠️

Render UI in Excalibur.js games using JSX with SolidJS. It is recommended to be familiar with Solid before using this library.

Installation

excalibur-ui requires either Babel or Vite to compile the JSX.

Babel

npm install excalibur-ui solid-js babel-preset-solid

Update your .babelrc file:

{
  "presets": [
    [
      "babel-preset-solid",
      {
        "moduleName": "excalibur-ui",
        "generate": "universal"
      }
    ]
  ]
}

Vite

npm install excalibur-ui solid-js vite-plugin-solid

Update your vite config file:

import { defineConfig } from 'vite'
import solidPlugin from 'vite-plugin-solid'

export default defineConfig({
  plugins: [
    solidPlugin({
      solid: {
        moduleName: 'excalibur-ui',
        generate: 'universal',
      },
    }),
  ],
})

Usage

UI can be rendered either on a Scene or Entity, and should be called once during onInitialize.

import { renderUI } from 'excalibur-ui'

class Scene extends ex.Scene {
  onInitialize() {
    renderUI(this, () => {
      return (
        <ex-text
          text="Hello World!"
          pos={ex.vec(100, 100)}
          color="#ffffff"
          font={{
            size: 50,
            family: 'Arial',
          }}
        />
      )
    })
  }
}

class Actor extends ex.Actor {
  onInitialize() {
    renderUI(this, () => {
      return (
        <ex-text
          text="Hello World!"
          pos={ex.vec(100, 100)}
          color="#ffffff"
          font={{
            size: 50,
            family: 'Arial',
          }}
        />
      )
    })
  }
}

Using state

Since excalibur-ui is build on top of Solid, you can use signals and effects the same way you would in Solid components.

You may want to manage state at the entity/scene level using class properties, so excalibur-ui provides a useValue hook that will provide a signal that is updated every frame. You can use this to get values from the parent entity/scene.

import { useValue } from 'excalibur-ui'

class Actor extends ex.Actor {
  onInitialize() {
    this.pos = ex.vec(100, 100)

    renderUI(this, () => {
      const pos = useValue(() => this.pos)

      return (
        <ex-text
          text="Hello World!"
          pos={pos()}
          color="#ffffff"
          font={{
            size: 50,
            family: 'Arial',
          }}
        />
      )
    })
  }
}

HTML elements

All HTML elements are supported and render on top of the game canvas.

import { useValue } from 'excalibur-ui'

class Actor extends ex.Actor {
  onInitialize() {
    this.pos = ex.vec(100, 100)

    renderUI(this, () => {
      const screenPos = useValue(() =>
        this.scene.engine.worldToScreenCoordinates(this.pos),
      )

      return (
        <div
          style={{
            position: 'absolute',
            top: `${screenPos().x}px`,
            left: `${screenPos().y}px`,
            color: 'white',
          }}
        >
          hello world
        </div>
      )
    })
  }
}

Excalibur elements

There's a lot missing here, but currently you can use:

  • ex-view
  • ex-graphic
  • ex-text
  • ex-rectangle

and these will render as native Excalibur entities onto the scene.

class Scene extends ex.Scene {
  onInitialize() {
    renderUI(this, () => {
      return (
        <ex-view pos={ex.vec(100, 100)}>
          <ex-graphic
            graphic={new ex.Circle({ radius: 5, color: ex.Color.Red })}
          />
          <ex-text
            text="Hello World!"
            pos={ex.vec(100, 100)}
            color="#ffffff"
            font={{
              size: 50,
              family: 'Arial',
            }}
          />
          <ex-rectangle
            pos={ex.vec(100, 300)}
            color="#ff4400"
            width={140}
            height={80}
          />
        </ex-view>
      )
    })
  }
}