1.0.1 • Published 6 years ago

onpe-alert v1.0.1

Weekly downloads
1
License
ISC
Repository
-
Last release
6 years ago

Alert

Componente para mostrar ventanas de resultados.

Requerimientos

  • AngularJS Material (y sus dependencias necesarias)

Instalación y uso

  • Instalar el componente utilizando npm:

      npm install onpe-alert
  • Agregar un link a la página

    <link rel="stylesheet" href="/node_modules/onpe-alert/onpe-alert.css"></script>
  • Agregar un <script> a la página

    <script src="/node_modules/onpe-alert/onpe-alert.js"></script>
  • Agregar el módulo onpe.alert al módulo principal del proyecto

      var app = angular.module("app", ['ngMaterial', 'onpe.alert'], function () {
      });
  • Agregar los servicios Alert y alertService al controlador respectivo

      app.controller('myctrl',function(Alert,alertService){
      });
  • Invocar a la función showAlert desde el controllador respectivo

      alertService.showAlert(argumentos...);
  • Los argumentos que recibe la función showAlert se detallan a continuación

    • Titulo (String - Obligatorio): Título del alert
    • Mensaje (String - Obligatorio): Contenido del alert
    • Tipo (Alert.TIPO - Obligatorio): Tipo de alert a mostrar (ALERT_SUCCESS,ALERT_ERROR,ALERT_WARNING,ALERT_MESSAGE)
    • TextoCancelar (String - Obligatorio): Texto que se mostrará en el botón cancelar del alert. Dejar vacío en caso no se quiera mostrar el botón
    • TextoAceptar (String - Obligatorio): Texto que se mostrará en el botón aceptar del alert. Dejar vacío en caso no se quiera mostrar el botón
    • callbackCancelar (Función - Obligatorio): Función a ejecutar cuando se elige la opción cancelar. Enviar null en caso no se requiera ninguna acción
    • callbackAceptar (Función - Obligatorio): Función a ejecutar cuando se elige la opción aceptar. Enviar null en caso no se requiera ninguna acción
    • mostrarCerrar (Opcional): Parámetro para indicar de que se desea mostrar la opción cerrar del alert. No enviar el parámetro en caso no se requiera mostrar la opción
  • Ejemplo de llamada a la función

      alertService.showAlert( "Título", "Hola mundo", Alert.TIPO.ALERT_SUCCESS, "Cancelar", "Aceptar", accionCancelar, accionAceptar);
    
      function accionAceptar(){
          console.log("accion aceptar");
      };
    
      function accionCancelar(){
          console.log("accion cancelar");
      };

Licencia

Copyright (c) 2018, Oficina Nacional de Procesos Electorales

Se concede por la presente el permiso para usar, copiar, modificar y/o distribuir este software para cualquier propósito con o sin cargo, siempre y cuando el aviso de copyright anterior y este aviso de permiso aparezcan en todas las copias.

EL SOFTWARE SE PROPORCIONA "TAL CUAL" Y EL AUTOR RECHAZA TODAS LAS GARANTÍAS CON RESPECTO A ESTE SOFTWARE, INCLUIDAS TODAS LAS GARANTÍAS IMPLÍCITAS DE COMERCIABILIDAD Y ADECUACIÓN. EN NINGÚN CASO EL AUTOR SERÁ RESPONSABLE POR CUALQUIER DAÑO ESPECIAL, DIRECTO, INDIRECTO O CONSECUENTE, O CUALQUIER DAÑO QUE RESULTE DE LA PÉRDIDA DE USO, DATOS O BENEFICIOS, YA SEA EN UNA ACCIÓN DE CONTRATO, NEGLIGENCIA U OTRA ACCIÓN EXTRACONTRACTUAL QUE SURJA DE O EN CONEXIÓN CON EL USO O RENDIMIENTO DE ESTE SOFTWARE.