shaku/src/gfx/text_alignments.js

A simple and effective JavaScript game development framework that knows its place!

/**
 * Define possible text alignments.
 * 
 * |-- copyright and license --|
 * @module     Shaku
 * @file       shaku\src\gfx\text_alignments.js
 * @author     Ronen Ness (ronenness@gmail.com | http://ronenness.com)
 * @copyright  (c) 2021 Ronen Ness
 * @license    MIT
 * |-- end copyright and license --|
 * 
 */

'use strict';

/** @typedef {String} TextAlignment */

/**
 * Possible text alignments.
 * @readonly
 * @enum {TextAlignment}
 */
const TextAlignments = {

    /**
     * Align text left-to-right.
     */
    Left: "left",

    /**
     * Align text right-to-left.
     */
    Right: "right",

    /**
     * Align text to center.
     */
    Center: "center",
};

Object.freeze(TextAlignments);
module.exports = {TextAlignments: TextAlignments};