Licence
ISC
Version
0.3.0
Deps
2
Size
33 kB
Vulns
0
Weekly
0
A UI library for the Phaser game framework.
Getting Started
After running the following command:
npm i phaser-uikit
You can import all available modules to your project with:
import * as UI from 'phaser-uikit'Or just the ones you need:
import { Button, Layout } from 'phaser-uikit'Components
Currently, the following components are supported:
| Component | Description |
|---|---|
| Button | Trigger a user action |
| Checkbox | Toggle a state on and off, or toggle multiple values from several options |
| Radio | Select a single value from several options |
| Layout | Order multiple elements into a layout |
How to Start the Project Locally
Run the following commands, to start the project locally and play around with some demo components:
git clone https://github.com/flowforfrank/phaser-ui.gitnpm inpm run start
How to Build the Project Locally
Run npm run build. This will create a dist folder with a minified version of all the available components.
Further Documentation
You can find documentation about the API and examples for all available components in the docs.