Package Exports

@telazer/game-ui-kit
@telazer/game-ui-kit/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@telazer/game-ui-kit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Telazer - Game UI Kit

For more helpers and utilities, check out Telazer NPM Page

A UI Kit for Games

Touch-event support permanently stopped due to a critical bug with version v1.0.17.

Customizable
Flexible
Responsive

Installation

npm install @telazer/game-ui-kit

Getting Started

Import GameUIKit into your TS app.

Key Features

Customization
Button
Modal
NineSlice

Usage

Initialization (If customization needed)

import GameUIKit from "@telazer/game-ui-kit";

GameUIKit.update({
  availableColors: {
    // You can modify existing colors in the palette.
    blue: {
      default: "#ff4757",
      light: "#ff6b81",
      lighter: "#ff8b99",
      dark: "#ee3939",
      darker: "#cc2929",
    },
    // Or you can add new colors
    custom: {
      lighter: #ff8a8a,
      light: #ffb3b3,
      default: #fe6262,
      dark: #e05252,
      darker: #c14242,
    },
  },
  availableSizes: {
    // You can modify existing size in the default list.
    default: "3vmin",
    // Or you can add new size
    customSmall: "15px", // it is not recommended to use absolute units.
    customLarge: "15vmin",
  },
  outlineWidth: "0.5vmin",
  childOutlineWidth: "0.25vmin",
});

Components

Docs -> https://telazer.itch.io/game-ui-kit-docs

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.