CODE SNIPPET: Advanced popup window

En este CODE SNIPPET, continuando y mejorando el anterior ‘Basic popup window’, voy a mostrar cómo se genera un plugin utilizando javascript y jquery, que muestre popup’s dinámicos.

Partiendo del código del post anterior y con el fin de reutilizar código para popup multiples, vamos a agrupar todo el contenido en un plugin que será el encargado de rellenar el popup e incluir toda la funcionalidad en un único archivo. De esta forma, tendremos la ventaja de poder generar popup’s de forma sencilla sin necesidad de repetir código.
Este pequeño plugin puede mostrar dos tipos de popups: bien una alerta estática de texto, bien un contenido de una capa.

Para ello, generaremos el código básico de un plugin, al que iremos añadiendo los distintos fragmentos de código, hasta completar el archivo.

Lo primero que haremos, será añadir los atributos base de nuestro plugin. Recordad que podemos ampliarlos, en función de nuestras necesidades. Por tanto, la primera aproximación queda así:


jQuery.fn.ShowPopup = function (options) {


    // atributos por dedecto, que extienden a options

    var settings = $.extend({

        cerrarText: '[X]', //texto para el botón de cerrar

        isAlert: false, //atributo que indica si es un popup de alerta o de objeto
        AlertText: undefined, //texto a mostrar en caso de tener una alerta estática
        onClose: undefined //callback a ejecutar tras cerrar el popup
    }, options);
    // creamos los metodos
    var methods = {};
    //creamos el plugin
    return this.each(function () {});

};

Como se puede ver, he incorporado una pequeña funcionalidad que puede ser útil, y es, la opción de pasar como parámetro una función para ejecutar cuando se cierra el popup. 

Una vez creados los atributos, procedemos a generar los métodos que utilizaremos para dar funcionalidad a nuestro plugin. Así, implementaremos tres métodos: open, close y destroy, encargados de abrir, cerrar y destruir el popup respectivamente:

    // creamos los metodos
    var methods = {
        open: function () { $('BODY > .popup').fadeIn(300); },
        close: function () { $('BODY > .popup').fadeOut(300, methods.destroy); },
        destroy: function (content) {
            //destruimos cualquier popup previo
            if ($('BODY > .popup').length) $('BODY > .popup').stop().hide().remove();
        }
    };

Con el método destroy, nos aseguramos de que sólo haya un popup en el body. La ventaja de utilizar estos métodos, reside en la facilidad para insertar animaciones y efectos a nuestro gusto, en las funciones de apertura y cierre (en este caso, unos simples efectos de alpha).

Por último, incorporamos el código que junta ambas partes y genera finalmente el popup:

//creamos el plugin
return this.each(function () {
    methods.destroy(); //destruimos cualquier popup previo

    //montamos las capas
    var wrapper = $('<div class="popup">');
    var popup = $('<div class="popup_window">');
    var closed = $('<div class="popup_close">');
    var content = $('<div class="popup_contenido">');

    //incorporamos los elementos al pop, y el pop al wrapper
    popup.append(closed).append(content);
    wrapper.append(popup);

    //incluimos el popup en el body
    $('body').append(wrapper);

    //inicializamos el boton cerrar
            
    closed.html(settings.cerrarText);
    closed.click(methods.close);
    if (jQuery.isFunction(settings.onClose)) closed.bind('click', settings.onClose);

    //incluimos el contenido (comprobamos si es texto o un objeto)
    if (settings.isAlert) {
    var alert_content = $('<div>' + settings.AlertText + '</div>');
    alert_content.addClass('contenido_alerta');
    content.html(alert_content);
    }
    else {
    //'Clone' de capa para no borrarla al 'destroy'
    var dinamic_content = $(this).clone();
    content.html(dinamic_content.show().addClass('contenido'));
    }

    //mostramos
    methods.open();
});

Sólo quedaría añadir los css y el código html para efectuar las llamadas que, a modo de ejemplo podrían ser:

<a href="#" onclick="$('#mipop').ShowPopup();">
Mostrar CAPA como popup
</a>


O con parámetros:

<a href="#" onclick="$('BODY').ShowPopup({cerrarText: 'CERRAR', isAlert:true, AlertText:$(this).html(), onClose:function(){alert('wow!');} });">
Mostrar alerta de nuevo un texto como popup, y avisar de su cierre.
</a>


En el siguiente enlace, podéis encontrar todo el código fuente de ejemplo.
Source Code

P.D: Mejorar y evolucionar este código queda ahora como algo más sencillo. Desde incluir varios botones, hasta personalizar todo el comportamiento. Sólo es cuestión de probar, fallar y al final encontrar qué es lo que mejor se adapta a nuestras necesidades.

Como siempre, espero que os sirva.
¡Un saludo a todos!
[...]

Leer más >>

CODE SNIPPET: Basic popup window


Con esta entrada, pretendo iniciar una serie de post que, como el propio título indica, sea un conjunto de publicaciones con pequeños fragmentos de código que se suelen utilizar en la mayoría de los proyectos. En este caso, el uso de un popup basico en html y javascript

Si al igual que yo, muchos de vosotros reutilizáis vuestro código en múltiples proyectos, habréis descubierto lo engorroso que es ir buscando en las carpetas de las aplicaciones archivadas, hasta descubrir dónde se encuentra el dichoso código para después copiarlo y pegarlo en el nuevo.

Pues bien, intentando evitar la pérdida de ese tiempo precioso, intentaré ir subiendo poco a poco ese tipo de  código reutilizable, para tener aquí una referencia en dónde buscarlo.

Y como inicio de esta sección os indicaré el código para obtener de forma sencilla un popup general, que muestre un contenido concreto, en forma de ventana emergente por encima del contenido de una página.

CODIGO HTML

Para empezar necesitaremos el fragmento de código HTML, que genere las capas correspondientes tanto en ubicación como en contenido.

<div id="MiPopup" class="popup">
    <div class="popup_window">
        <div class="popup_close" title="Cerrar onclick="CierraPopup(this);">[cerrar]</div>
        <div class="popup_contenido"></div>
    </div>
</div>

Básicamente, la idea de este fragmento es la construcción de una capa base (‘popup’), que ocultará todo el contenido bajo ella, y otra centrada (‘popup_window’), con unas dimensones concretas que será la que muestre el contenido.

Las dos capas internas de la ventana centras son para separar el contenido a mostrar (‘popup_contenido’) del botón para cerrar el popup (‘popup_cerrar’).

NOTA: El tag ‘onclick’ de la capa ‘popup_close’ será el encargado de ocultar el popup al pulsarse. La función para realizarlo, la puedes obtener más abajo.

CODIGO CSS

Una vez que tenemos la estructura general montada, debemos darle el estilo CSS. Aquí está el código de ejemplo:

.popup {
    background-color:rgba(0,0,0, 0.5);
    display: none;
    height: 100%;
    left: 0;
    position: fixed;
    top: 0;
    width: 100%;
    z-index: 100000;
    color:#fff;
}
.popup_window {
    background-color:#333;
    box-shadow:0 0 12px 12px #FFF;
    height: 300px;
    margin: -150px auto 0;
    position: relative;
    top: 50%;
    width: 400px;
 }
.popup_window > .popup_close {
    cursor:pointer;
    position:absolute;
    right: 10px;
    top: 10px;
}
.popup_window > .popup_contenido {
    margin: 0 auto;
    text-align: center;
    width: 100%;
}

Evidentemente éste es solo un ejemplo, y en nuestro caso hemos generado una ventana centrada de 400x300 pixels. Cualquier parámetro puede ser modificado al gusto, e incluso podemos insertar imágenes de background para personalizar aún más el resultado.

CODIGO Javascript

Por último, sólo nos faltaría implementar el javascript para que la ventana se muestre y se oculte con la interacción del usuario. Para esto, simplemente añadimos el siguiente javascript:

<script type="text/javascript">
    function MuestraPopup(pop) {
        document.getElementById(capa).style.display = 'show';
    }
    function CierraPopup(pop_close) {
        pop_close.parentNode.parentNode.style.display = 'none';
    }
</script>

NOTA: Recomiendo utilizar algún framework de javascript, por la comodidad de programación, estructuración y modelado del código.

Simplemente restaría añadir en la página HTML un botón para mostrar dicho popup. Dado que se podría hacer de muchas formas, os indico la más simple, que sería añadir un link en la página:
<a href="#" onclick="MuestraPopup('MiPopup'); return false;">Abrir Pop-up</a>

NOTA: El return false; lo añado para evitar que se ejecute la navegación del href y se recargue la página.

Con este pequeño fragmento de código, ya podéis tener vuestras propias ventanas informativas, sin peligro de bloqueos de popup, ni nada por el estilo. Y además, totalmente personalizables.

Espero que os ayude.
¡Un saludo a todos!



[...]

Leer más >>