npm package: @hcd-bsas/loading
Description: Desde el archivo loading.js se exporta la clase **LoadingHCD** la cual permite mostrar o ocultar el html **/src/template.html** que contiene la animación del overlay con el Logo en SVG.
Latest version: 0.0.3


# Loading Overlay

## Estructura del proyecto

Desde el archivo loading.js se exporta la clase **LoadingHCD** la cual permite mostrar o ocultar el html **/src/template.html** que contiene la animación del overlay con el Logo en SVG.

Ademas las clases CSS se encuentran en **(/src/style.css)**.

## Pre-requisitos

### Es necesario tener instalado

* [Node Js LTS](https://nodejs.org/en/) La versión utilizada para el primer desarrollo fue 16.14.0 LTS.
* [yarn](https://yarnpkg.com/) 

    ~~~ 
    npm install -g yarn
    ~~~

### Recomendaciones opcionales para instalar

* [Visual Studio Code](https://code.visualstudio.com/)
* [CMDER](https://github.com/cmderdev/cmder) es una consola de comandos sencilla con algunas sintaxis linux

## Instalación

El proyecto javascript esta armado con [webpack](https://webpack.js.org/concepts/) y algunas librerías adicionales. 

Su instalación es sencilla ejecutando en la raíz del directorio el comando **install** que agregara todas las dependencias necesarias:

~~~
    yarn install
~~~

## Compilación desarrollo

El comando **serve** compila el proyecto sin comprimirlo y activa la opción [watch](https://webpack.js.org/configuration/watch/) que permite a webpack observar los archivos y recompilarlos si cambian.

~~~
    yarn serve
~~~

Este archivo compilado se encontrara en el directorio **dist** y se puede probar haciendo uso del **test.html** que se encuentra en la raíz y se puede abrir con cualquier navegador web.

## Compilación productiva y publicación en NPM

### Compilación producción

El comando **build** compila el proyecto comprimido para luego poder ser distribuido.

~~~
    yarn build
~~~

### Publicación NPM

Posteriormente para poder publicar la librería en [NPM](https://www.npmjs.com/) se debe:

1) Tener un usuario registrado. [Ir al registro...](https://www.npmjs.com/signup)

2) Acceder a la cuenta de NPM de la HDC desde el navegador y agregar como administrador al usuario registrado en la organización **@hcd-bsas**. Credenciales: 

    > Usuario: desarrollohcd

    > Contraseña:  "la misma que se utiliza en el correo hcddesarrolladoras@gmail.com"

3) Autenticar con el usuario registrado en el paso 1 desde la linea de comandos

~~~
    yarn login
~~~

4) Asegurase de previamente haber compilado la librería en modo producción (comando **build**).

5) Publicar librería con el comando **publish**, el cual preguntara cual es el nuevo número de versión. En donde "version": *.*.* --> El primer número corresponde a cambios grandes, el segundo nuevas funcionalidades y el tercero corrección de errores o cambios menores.

~~~
    yarn publish
~~~

Nota: En ocasiones da el error "You cannot publish over the previously published versions" al no poder cambiar la versión de la librería desde la linea de comandos. Para ello se debe aumentar el número de versión en la opción **version** del package.json

### Como hacer uso de la librería con NPM

Pero para poder instalar la librería en cualquier otro proyecto se debe correr el comando en el directorio donde el proyecto contenga las librerías javascript.

~~~
    yarn add @hcd-bsas/loading
~~~

Luego es necesario importar el archivo LoadingHCD.min.js y crear una nueva instancia:

~~~
    // Librería javascript SIN DEPENDENCIA DE JQUERY
    <script src="../node_modules/@hcd-bsas/loading/dist/LoadingHCD.min.js"></script>

    <script>
        var loading = new LoadingHCD(); // Instancia de la clase
    </script>
    <button onclick="loading.show()" >Mostrar</button>
    <button onclick="loading.hide()" >Ocultar</button>
~~~

Desde la clase **LoadingHCD** podemos invocar los métodos públicos **show** y **hide**, por ejemplo:

~~~
    <button onclick="loading.show()" >Mostrar</button>
    <button onclick="loading.hide()" >Ocultar</button>
~~~