terminalBG

Info

terminalBG es una biblioteca programada en JavaScript para dar formato y estilo a los mensajes sacados por la consola del navegador.

La biblioteca trae un conjunto de templates con opciones predefinidas y también permite crear templates propios.

Instalación

Hay dos archivos diferentes, una versión para proyectos clásicos y otra para proyectos con el sistema de módulos.

Instalación clásica <script src="./terminal-bg-classic.js"></script> Instalación con módulo import { terminalBG } from "./terminal-bg-module.js";

Uso básico

tBG() es el constructor de la biblioteca, se le puede envíar un argumento con el mensaje que se quiere mostrar.
_() es es el método para mostrar el mensaje en la consola.

Uso básico tBG("texto de salida")._();

Llamar a múltiples métodos

La biblioteca permite encadenar métodos en su llamada, se van resolviéndo en orden, de izquierda a derecha.

Múltiples métodos tBG("texto de salida").color("#FF0000").bcolor("#00FF00")._();

Templates

Estar utilizando todo el rato una ristra de comandos encadenados es muy molesto y no tendría sentido, la intención de la biblioteca es usar templates. Los templates funcionan como un conjunto de macros de comandos y código JavaScript.

Puedes ver los comandos disponibles de terminalBG en la sección Comandos.

Se pueden crear templates modificando el archivo de la biblioteca, añadiendo entradas al objeto de la constante templates. La clave de la nueva entrada será el nombre del template, y el valor de la entrada será una función que ejecute las instrucciones del template.

Añadir un template llamado 'matrix' const templates = {
'matrix': templateMatrix,
}

La función asignada debe de tener la siguiente estructura, recibir un argumento, ejecutar

Comandos

Los botones ejecutar en la consola muestran el resultado de su correspondiente ejemplo en la consola del navegador (pulsa F12 para abrir las herramientas de desarrollo).

bColor Cambia el color de fondo mediante el argumento que se envía. Admite cualquier formato válido de colores CSS. tBG("texto de salida").bcolor("blue")._();
bold Pone el texto en negrita. tBG("texto de salida").bold()._();
border Establece la propiedad border con formato CSS mediante el argumento que se envía. tBG("texto de salida").border("solid 3px orange")._();
bRadius Establece la propiedad border-radius con formato CSS mediante el argumento que se envía. tBG("texto de salida").bRadius("10px")._();
clear Limpia los mensajes de la consola. tBG().clear();
color Cambia el color del texto al que se envía mediante un argumento. Admite cualquier formato válido de colores CSS. tBG("texto de salida").color("#FF0000")._();
img Dibuja una imagen en la consola, se le envía como primer parámetro una imagen en base64, el segundo parámetro es opcional y establece el tamaño de la imagen en porcentaje. const img = "Código de la imagen en base64 aquí";

tBG().img(img, 150);
padding Recibe un valor numérico y establece el padding a ese valor en pixels. tBG("texto de salida").padding("20px")._();
px Recibe un valor numérico y establece el tamaño de la fuente a ese valor en pixels. tBG("texto de salida").px(17)._();
rem Recibe un valor numérico y establece el tamaño de la fuente a ese valor en la unidad REM. tBG("texto de salida").rem(20)._();
shadow Establece la propiedad text-shadow con el valor pasado como argumento. tBG("texto de salida").shadow("1px 1px 2px yellow")._();
size Establece el tamaño del texto, según lo enviado en el argumento. Admite cualquier formato de CSS válido para la propiedad font-size. tBG("texto de salida").size("10rem")._();
template Carga el template con el nombre que se le envía por argumento. tBG("texto de salida").template("matrix")._();
width Establece el width del mensaje de la consola. Admite cualquier formato de CSS válido para la propiedad width. tBG("texto de salida").width("300px")._();