2048-webcomponent


This is 2048 as a WebComponent. Once you integrate it as described further, the game just follows the standard rules. To make a move, just use the arrow keys or swipe.

Getting Started

Install the package via npm or yarn and deliver the script to the user.
This can be done via import, require or just inserting a script tag.

``shell
npm i 2048-webcomponent
`

`shell
yarn add 2048-webcomponent
`

Attributes

| Param | Type | Description | Default |
| -------------------------- | -------- | -------------------------------------------------------------------------------- | ------- |
| columns | number | Amount of columns of the board. | 4 |
| rows | number | Amount of rows of the board. | 4 |
| swipe-distance-threshold | number | Amount of pixels required to trigger a swipe. | 50 |
| restart-selector | string | If present, attaches a click event listener to the element to trigger a restart. | |

Events

By default, each event contains the current game state in event.detail.game. To discourage cheating, no events should be logged in the browser console.
| Name | Type | Cancelable | Description | detail |
| ---------------- | --------------- | ------------------ | ----------------------- | ------------------------------------------------------------------------------------------------------------ |
| 2048:game-won | GameWonEvent | :x: | User just won the game |

• positions: Positions current game state

|
| 2048:game-lost | GameLostEvent | :x: | User just lost the game |

• positions: Positions current game state

|
| 2048:move | MoveEvent | :white_check_mark: | User made a move |

• positions: Positions current game state
• direction: Direction direction of the move

|
| 2048:score | ScoreEvent | :x: | Score has been updated |

• positions: Positions current game state
• oldScore: number \| undefined old score
• delta: number \| undefined difference between old and new score
• newScore: number current score

|

Usage

$3

Just a basic 9x9 / 10 Mines 2048 game. Further examples can be combined.

`html



`

$3

Define your own custom tag name

`html



`

$3

Provide a selector where a "click"-event will be attached to, to restart the game.

`html

Restart!


`

$3

Write custom logic to restart the game.

`html

Restart with Confirm!


`

$3

Attach an EventListener for the win/lose events.

`html



`

$3

Of course you can provide different configurations for the game.

`html



`

Example

Try it out at CodePen.

!Example Image

TypeScript

The whole package is written in TypeScript and therefore provides a strongly typed system via the core export of the package:

`html


`

`typescript
// some-file.ts
import '2048-webcomponent/custom-element';
import { FieldInteractionEvent, FieldInteractionType } from '2048-webcomponent/core';
import type { Game } from '2048-webcomponent/core';

const game = document.querySelector('#game') as Game;
game.addEventListener('2048:field-interaction', (event: FieldInteractionEvent) => {
const { interaction } = event.detail;
switch (interaction.type) {
case FieldInteractionType.Unveiled:
console.log('Revealed field value:', interaction.value);
break;
case FieldInteractionType.FlagAction:
case FieldInteractionType.QuestionMarkAction:
console.log('Performed action:', interaction.action);
break;
}
});
`

Engine

The engine can be used as a standalone library (commonjs and esm) via the engine export of the package. This enables the usage of the engine in every application (server- or client-side).

`javascript
import { Direction } from '2048-webcomponent/core';
import { Engine } from '2048-webcomponent/engine';

const engine = new Engine();

engine.createBoard(3, 3);

engine.move(Direction.Up);

if (engine.isGameOver) {
// Restarts the game with the initial configuration
engine.restart();
}
`

`javascript
const { Engine } = require('2048-webcomponent/engine');

const engine = new Engine();

// ...
``

License

MIT License