Magic ConsoleLog

This package allows you to print beautiful console.log.

This console.log is used by companies that leave messages on the console of websites for when the user inspects a page, stating some precautions or even rewards.

Downloads

Statistics of this lib on NPM.

TotalWeeklyMonthlyYearly
npmnpmnpmnpm

How to install?

CDN
Unpkg JS
  https://unpkg.com/@vlalg-nimbus/magic-consolelog/dist/bundle.min.umd.js
To install
YARN
  yarn add @vlalg-nimbus/magic-consolelog
NPM
  npm i @vlalg-nimbus/magic-consolelog

How to use?

import MagicConsole from '@vlalg-nimbus/magic-consolelog'

const rainbowConfig = {
  title: 'Rainbow Type',
  titleConfig: {
  color: '#ffffff',
    size: '50px',
    background: 'transparent',
    shadow: [
      'rgb(217,31,38)',
      'rgb(226,91,14)',
      'rgb(245,221,8)',
      'rgb(5,148,68)',
      'rgb(2,135,206)',
      'rgb(4,77,145)',
      'rgb(42,21,113)',
    ],
  },
  text: 'Rainbow Text',
  hasLink: true,
  link: {
    text: 'Link description',
    url: 'https://github.com/VemLavarALoucaGamers/vlalg-nimbus',
  },
};

new MagicConsole('rainbow', rainbowConfig);

Options

The lib instance accepts two parameters (not optional):

  • type: Type of Title
  • config: Configuration of console.log
new MagicConsole(type, config)

Type

It is the first parameter that must be passed, it accepts the following values:

  • normal
  • bold
  • background
  • rainbow
Background Example
  new MagicConsole('background', config)
Rainbow Example
  new MagicConsole('rainbow', config)

The default value is normal.

Config

It is the second parameter that must be passed, it accepts the following properties:

  • title: The company name or a word of attention is usually defined.
  • titleConfig: This property is an object with two required properties (color and size) and two optional properties (background and shadow).
    • The background property is used for the background type.
    • The shadow property is used for the rainbow type, the shadow expects to receive an array with seven colors.
  • text: It is used to inform something.
  • hasLink: Accepts true or false, if set to true we can set the link property.
  • link: If the previous property was set to true, we can set this. This property is an object with two required properties, text and link. Text is the text that references the link.

OBS: The values of the properties contained in titleConfig are css, so it is possible to define colors and backgrounds in HEX, RGB or transparent.

const config = {
  title: 'Rainbow Type',
  titleConfig: {
  color: '#ffffff',
    size: '50px',
    background: 'transparent',
    shadow: [
      'rgb(217,31,38)',
      'rgb(226,91,14)',
      'rgb(245,221,8)',
      'rgb(5,148,68)',
      'rgb(2,135,206)',
      'rgb(4,77,145)',
      'rgb(42,21,113)',
    ],
  },
  text: 'Rainbow Text',
  hasLink: true,
  link: {
    text: 'Link description',
    url: 'https://github.com/VemLavarALoucaGamers/vlalg-nimbus',
  },
};

MagicConsole('rainbow', config)
Table of Contents