lazy-widgets/dist/core/Strings.js

Typescript retained mode GUI for the HTML canvas API

const baseCanvasContextMsg = 'Failed to get DOM canvas context. Make sure the 2D canvas context is supported';
const badTextImpl = 'Text render group generation is incorrectly implemented. Please report this bug if you are not responsible for text rendering for this Widget.';
/**
 * Standard static console messages.
 *
 * @category Core
 */
export const Msg = {
    CANVAS_CONTEXT: `${baseCanvasContextMsg}.`,
    REUSABLE_CANVAS_CONTEXT: `${baseCanvasContextMsg} and the canvas is not being reused with a different rendering context.`,
    NEGATIVE_TEXT_GROUP: `Unexpected text render group with negative width detected. ${badTextImpl}`,
    EMPTY_LINE_RANGE: `Unexpected line range without any text render groups. Empty lines must contain a zero-width text render group. ${badTextImpl}`,
    ROGUE_NEWLINE: `Unexpected line range with newline character in the middle of the range instead of at the end. Text after newline character was ignored. ${badTextImpl}`,
    VIDEO_API_AVAILABLE: 'HTMLVideoElement.requestVideoFrameCallback is available and will be used; if video playback is choppy or broken, please report it on Github',
    DIMENSIONLESS_CANVAS: 'Canvas has 0 width or height. Are you using an empty Root? If not, make sure to not over-constrain the Widgets.',
    NON_POW2_CANVAS: 'Canvas has a width or height that is not a power of 2, which may create mipmapping issues for 3D engines. Make sure to use power of 2 starting and maximum canvas dimensions.',
    DOM_DRIVER_REBIND: 'Re-binding DOM driver. Are you calling bindDOMElem with the same HTML element multiple times?',
    PARENTLESS_CLIPVP: 'Attempt to use ClippedViewport without a parent. If you are implementing a custom Root subclass, keep in mind that a Viewport with a rendering context must be used; ClippedViewport can\'t be used because it inherits a parent Viewport\'s rendering context.',
    SCROLLBAR_INVIS_PAD: 'Scrollbar is invisible due to added padding consuming all available space. Consider using smaller padding to prevent this issue.',
};
function propStr(name) {
    if (typeof name === 'string') {
        return name;
    }
    else {
        return '<Symbol()>';
    }
}
function valueStr(value) {
    if (typeof value === 'string') {
        return `"${value}"`;
    }
    else {
        return String(value);
    }
}
const fpCause = 'This may be caused by floating pointer precision errors.';
/**
 * Standard dynamic console messages.
 *
 * @category Core
 */
export const DynMsg = {
    INVALID_BACKGROUND_FILL: (backgroundProperty) => `Unknown theme property: ${propStr(backgroundProperty)}. Valid background fill theme properties: "primaryFill", "accentFill", "backgroundGlowFill" and "backgroundFill".`,
    SWAPPED_MIN_MAX_NAMED: (minValue, maxValue, minName, maxName) => `${propStr(maxName)} value (${valueStr(maxValue)}) can't be smaller than ${propStr(minName)} value (${valueStr(minValue)}).`,
    SWAPPED_MIN_MAX: (minValue, maxValue) => DynMsg.SWAPPED_MIN_MAX_NAMED(minValue, maxValue, 'Minimum', 'Maximum'),
    INVALID_VALUE: (name, value, nonNegative = false) => `${propStr(name)} value (${valueStr(value)}) must be a valid${nonNegative ? ' non-negative' : ''} finite number. Make sure that it's not infinite and not NaN.`,
    NEGATIVE_VALUE: (name, value) => `${propStr(name)} value (${valueStr(value)}) must be greater or equal to zero.`,
    NON_ARRAY_VALUE: (name, value) => `${propStr(name)} value (${valueStr(value)}) must be an array.`,
    INVALID_MIN: (value) => DynMsg.INVALID_VALUE('Minimum', value),
    INVALID_MAX: (value) => DynMsg.INVALID_VALUE('Maximum', value),
    INVALID_INC: (value) => DynMsg.INVALID_VALUE('Increment', value),
    NEGATIVE_INC: (value) => DynMsg.NEGATIVE_VALUE('Increment', value),
    SWAPPED_MIN_MAX_DIMS: (minValue, maxValue, minName, maxName) => `${DynMsg.SWAPPED_MIN_MAX_NAMED(minValue, maxValue, minName, maxName)} Set ${propStr(minName)} to ${propStr(maxName)}. ${fpCause}`,
    NEGATIVE_DIMS: (value, name) => `${DynMsg.NEGATIVE_VALUE(name, value)} Set ${propStr(name)} to 0. ${fpCause}`,
    BROKEN_CONSTRAINTS: (value, limit, horizontal, overflow) => `${horizontal ? 'Horizont' : 'Vertic'}al ${overflow ? 'ov' : 'und'}erflow in Widget; Limit: ${limit}, actual value: ${value}.`,
    INVALID_DIMS: (horizontal, value) => DynMsg.INVALID_VALUE(horizontal ? 'Width' : 'Height', value, true),
    DETACHED_WIDGET: (name) => `Cannot get ${name} property; Widget is not attached to a UI tree. Make sure the Widget is in a UI tree and to never directly call Widget update, layout resolution or painting methods.`,
    INVALID_ATTACHMENT: (attaching) => `Attempt to ${attaching ? 'at' : 'de'}tach ${attaching ? 'at' : 'de'}tached Widget. Make sure the Widget is not being reused in another Root without first removing it from the first Root.`,
    INVALID_KB_ROW_TEMPLATE: (entry) => `Unknown virtual key row template format for entry: ${entry}. A key row template must either be a function that returns a VirtualKey instance, or a pair of symbols.`,
    INVALID_ENUM: (value, enumName, variableName, unexpected = false) => `${unexpected ? 'Unexpected' : 'Unknown'} ${enumName} value: ${value}. Make sure ${variableName} is being passed as an enum value instead of its corresponding hardcoded value; this value may have become invalid due to an update.${unexpected ? ' If this is a valid value, then this may be a bug caused by invalid input combinations. Please report it.' : ''}`,
    OVERCAPTURING_WIDGET: (capturer) => `TabSelectEvent event captured by widget (${capturer.constructor.name}), but reachedRelative was false; a widget type is probably capturing events by default. Make sure to only capture events that you need so that other Widgets aren't broken.`,
    MAYBE_DIMENSIONLESS: (axisName) => `ViewportWidget has no minimum ${axisName} and ${axisName} isn't bi-directionally coupled, therefore, it may be dimensionless. Set a minimum ${axisName} and/or bi-directionally couple the ${axisName}.`,
};
/**
 * Print a stack trace inside a collapsed group to the console.
 *
 * @category Core
 */
export function groupedStackTrace() {
    console.groupCollapsed('Stack trace');
    console.trace();
    console.groupEnd();
}
//# sourceMappingURL=Strings.js.map