Create the component for a role in design in the context of game development.
Go to file
André Jaenisch a707d67e72
docs: update README
I'm going to publish this package now.

Signed-off-by: André Jaenisch <andre.jaenisch@posteo.de>
2023-10-06 11:09:08 +02:00
dist feat: add component 2023-10-06 11:08:07 +02:00
src feat: add component 2023-10-06 11:08:07 +02:00
test feat: add component 2023-10-06 11:08:07 +02:00
types/src feat: add component 2023-10-06 11:08:07 +02:00
.c8rc.json chore: configure tooling 2023-10-06 11:06:37 +02:00
.gitignore feat: add component 2023-10-06 11:08:07 +02:00
.mocharc.cjs chore: configure tooling 2023-10-06 11:06:37 +02:00
LICENSE.txt fix: correct name in LICENSE.txt 2023-10-06 11:00:36 +02:00
README.md docs: update README 2023-10-06 11:09:08 +02:00
package.json chore: turn into JavaScript project 2023-10-06 11:01:32 +02:00
prettier.config.js chore: configure tooling 2023-10-06 11:06:37 +02:00
rollup.config.js chore: configure tooling 2023-10-06 11:06:37 +02:00
tsconfig.json chore: configure tooling 2023-10-06 11:06:37 +02:00
yarn.lock chore: turn into JavaScript project 2023-10-06 11:01:32 +02:00

README.md

guido-component-game-role-design

Create the component for a role in design in the context of game development.

Usage

Import

The code can be used as an ES Module

import { component } from '@guido.software/guido-component-game-role-design'

or as IIFE:

<script src="./js/vendor/guido-component-game-roles-design.min.js"></script>
<script>window.design = window.software.guido.components.game.roles.design</script>

Then use it as:

var serialised = window.design(document.createElement('div'), {}, JSON.stringify)

API

This component expects an HTMLElement to replace, a Redux-like state object and a builder to transform the GIL into a consumable format. GIL object. GIL stands for Guido Interface Language. It is a JSON-serialisable representation of a view. The focus is on DOM, but it can be extended to support other markup languages as well.

Installation

With npm:

npm install @guido.software/guido-component-game-role-design

With yarn

yarn add @guido.software/guido-component-game-role-design

Issues

The code is mirrored on Codeberg in case you want to report errors. I don't accept registrations on my Forgejo instance.

LICENSE

AGPL version 3 or newer. See LICENSE