Thoun at 12:34, 29 July 2026

2026-07-29T12:34:03Z

← Older revision		Revision as of 14:34, 29 July 2026
Line 2:		Line 2:

	== Overview ==		== Overview ==
	'''bga-jump-to''' is a component to add ~~shortcut~~ to the different ~~board~~ of the game.		'''bga-jump-to''' is a component to add shortcuts to the different boards of the game.

	It should only be used if the game has numerous boards, and it usually doesn't fit in the screen. Showing it with little number of elements on the screen will just pollute the game area uselessly.		It should only be used if the game has numerous boards, and it usually doesn't fit in the screen. Showing it with little number of elements on the screen will just pollute the game area uselessly.

Thoun: Created page with "{{Studio_Framework_Navigation}} == Overview == '''bga-jump-to''' is a component to add shortcut to the different board of the game. It should only be used if the game has numerous boards, and it usually doesn't fit in the screen. Showing it with little number of elements on the screen will just pollute the game area uselessly. The games Akropolis, Knarr, Path of Civilization are examples of usage. To see how its work and access examples of source code (via browser d..."

2026-07-29T12:27:34Z

Created page with "{{Studio_Framework_Navigation}} == Overview == '''bga-jump-to''' is a component to add shortcut to the different board of the game. It should only be used if the game has numerous boards, and it usually doesn't fit in the screen. Showing it with little number of elements on the screen will just pollute the game area uselessly. The games Akropolis, Knarr, Path of Civilization are examples of usage. To see how its work and access examples of source code (via browser d..."

New page

{{Studio_Framework_Navigation}}

== Overview ==
'''bga-jump-to''' is a component to add shortcut to the different board of the game.

It should only be used if the game has numerous boards, and it usually doesn't fit in the screen. Showing it with little number of elements on the screen will just pollute the game area uselessly.

The games Akropolis, Knarr, Path of Civilization are examples of usage.

To see how its work and access examples of source code (via browser dev tools) see
'''<big>[https://x.boardgamearena.net/data/game-libs/bga-jump-to/1.x/demo/index.html Demo]</big>'''

For comprehensive API docs see
'''<big>[https://x.boardgamearena.net/data/game-libs/bga-jump-to/1.x/docs/index.html Doc]</big>'''

== Usage ==
Load the lib:
<pre>
const BgaJumpTo = await importEsmLib('bga-jump-to', '1.x');
</pre>
This line should be placed on top of the JS file, before any class declaration.

Legacy way;
<pre>
define([
"dojo","dojo/_base/declare",
"ebg/core/gamegui",
"ebg/counter",
getLibUrl('bga-jump-to', '1.x'),
],
function (dojo, declare, gamegui, counter, BgaJumpTo) { // note that the index of `BgaJumpTo` must match the index of the define array
</pre>

In your game setup:
<pre>
const entries = [
new BgaJumpTo.Entry(_('Main board'), 'table-center', { color: '#224757', backgroundImage: `url('${this.bga.images.getImgUrl('board.jpg')}')` }),
];
entries.push(...BgaJumpTo.BgaPlayerEntries(this.bga, {
entryTarget: (playerId, player) => `player-table-${player.no}`,
}));

new BgaJumpTo.Manager({
localStorageFoldedKey: LOCAL_STORAGE_JUMP_TO_FOLDED_KEY,
entries,
});
</pre>

Also define <code>const LOCAL_STORAGE_ZOOM_KEY = '<yourgamename>-folded';</code> so the user prefered state is stored on his device.

== Versioning ==
The lib is using semver, so you can require 1.x to be sure to have the last fixes without risking a breaking change. Any breaking change will be noted on the Changelog section.

== Using with TypeScript ==
If you use TypeScript and this lib, you can download the '''[https://x.boardgamearena.net/data/game-libs/bga-jump-to/1.x/dist/bga-jump-to.d.ts d.ts]''' file to put in on your game folder to benefit from auto-completion. Depending on the way you build, you might need to remove the last line (the export instruction) to be able to use it.

== Developer notes ==

BgaPlayerEntries is customizable to fit your needs.

== Changelog ==
'''1.0.0''': Initial version
[[Category:Studio]]

BgaJumpTo - Revision history

Thoun at 12:34, 29 July 2026