element

16 KiB

Raw Blame History

MessageBox

Un conjunto de cajas modales simulando un sistema de message box, principalmente para alertar informacion, confirmar operaciones y mostrar mensajes de aviso. :::tip Por diseño los message box nos proveen de simulaciones de sistemas como los componentes alert, confirm y prompt，entonces su contenido debería ser simple. para contenido mas complejo, por favor utilize el componente Dialog. :::

Alert

Alert interrumpe las operaciones realizadas hasta que el usuario confirme la alerta.

:::demo Desplegar una alerta utilizando el metodo $alert. Simula el sistema alert, y no puede ser cerrado al presionar la tecla ESC o al dar click fuera de la caja. En este ejemplo, dos parametros son recibidos message y title. Vale la pena mencionar que cuando la caja es cerrada, regresa un objeto Promise para su procesaimiento posteriormente. Si no estas seguro si el navegador soporta Promise, deberias importar una libreria de terceros de polyfill o utilizar callbacks.

<template>
  <el-button type="text" @click="open">Click to open the Message Box</el-button>
</template>

<script>
  export default {
    methods: {
      open() {
        this.$alert('This is a message', 'Title', {
          confirmButtonText: 'OK',
          callback: action => {
            this.$message({
              type: 'info',
              message: `action: ${ action }`
            });
          }
        });
      }
    }
  }
</script>

:::

Confirm

Confirm es utilizado para preguntar al usuario y recibir una confirmacion.

:::demo llamando al metodo $confirm para abrir el componente confirm, y simula el sistema confirm.Tambien podemos perzonalizar a gran medida el componente Message Box al mandar un tercer atributo llamado options que es literalmente un objeto . El atributo type indica el tipo de mensaje, y su valor puede ser success, error, info y warning. Se debe tener en cuenta que el segundo atributo title debe ser de tipo string, y si es de tipo object, sera manejado como el atributo options. Aqui utilizamos Promise para manejar posteriormente el proceso.

<template>
  <el-button type="text" @click="open2">Click to open the Message Box</el-button>
</template>

<script>
  export default {
    methods: {
      open2() {
        this.$confirm('This will permanently delete the file. Continue?', 'Warning', {
          confirmButtonText: 'OK',
          cancelButtonText: 'Cancel',
          type: 'warning'
        }).then(() => {
          this.$message({
            type: 'success',
            message: 'Delete completed'
          });
        }).catch(() => {
          this.$message({
            type: 'info',
            message: 'Delete canceled'
          });          
        });
      }
    }
  }
</script>

:::

Prompt

Prompt es utilizado cuando se requiere entrada de informacion del usuario.

:::demo LLamando al metodo $prompt desplegamos el componente prompt, y simula el sistema prompt.Puedes utilizar el parametro inputPattern para especificar tu propio patron RegExp. Utiliza el parametro inputValidator para especificar el metodo de validacion, y debería regresar un valor de tipo Boolean o String. Al regresar false o String significa que la validacion a fallado, y la cadena regresada se usara como inputErrorMessage.Ademas, puedes perzonalizar el atributo placeholder del input box con el parametro inputPlaceholder.

<template>
  <el-button type="text" @click="open3">Click to open Message Box</el-button>
</template>

<script>
  export default {
    methods: {
      open3() {
        this.$prompt('Please input your e-mail', 'Tip', {
          confirmButtonText: 'OK',
          cancelButtonText: 'Cancel',
          inputPattern: /[\w!#$%&'*+/=?^_`{|}~-]+(?:\.[\w!#$%&'*+/=?^_`{|}~-]+)*@(?:[\w](?:[\w-]*[\w])?\.)+[\w](?:[\w-]*[\w])?/,
          inputErrorMessage: 'Invalid Email'
        }).then(value => {
          this.$message({
            type: 'success',
            message: 'Your email is:' + value
          });
        }).catch(() => {
          this.$message({
            type: 'info',
            message: 'Input canceled'
          });       
        });
      }
    }
  }
</script>

:::

Personalización

Puede ser personalizado para mostrar diversos contenidos.

:::demo Los tres metodos mencionados anteriormente son un rempaquetado del metodo $msgbox. En este ejemplo se realiza una llamada al metodo $msgbox directamente utilizando el atributo showCancelButton, el cual es utilizado para indicar si el boton cancelar es mostrado en pantalla. Ademas podemos utilizar el atributo cancelButtonClass para agregar un estilo personalizado y el atributo cancelButtonText para personalizar el texto del boton (el boton de confirmacion tambien cuenta con estos campos, y podras encontrar una lista completa de estos atributos al final de esta documentacion). Este ejemplo tambien utiliza el atributo beforeClose.Es un metodo que es disparado cuando una instancia del componente MessageBox es cerrada, y su ejecucion detendra el cierre de la instancia. Tiene tres parametros: action, instance y done. Al utilizarla te permite maniluplar la instancia antes de que sea cerrada, e.g. activando loading para el boton de confirmacion; puedes invocar el metodo done para cerrar la instancia del componente MessageBox (si el metodo done no es llamado dentro del atributo beforeClose, la instancia no podra cerrarse).

<template>
  <el-button type="text" @click="open4">Click to open Message Box</el-button>
</template>

<script>
  export default {
    methods: {
      open4() {
        const h = this.$createElement;
        this.$msgbox({
          title: 'Message',
          message: h('p', null, [
            h('span', null, 'Message can be '),
            h('i', { style: 'color: teal' }, 'VNode')
          ]),
          showCancelButton: true,
          confirmButtonText: 'OK',
          cancelButtonText: 'Cancel',
          beforeClose: (action, instance, done) => {
            if (action === 'confirm') {
              instance.confirmButtonLoading = true;
              instance.confirmButtonText = 'Loading...';
              setTimeout(() => {
                done();
                setTimeout(() => {
                  instance.confirmButtonLoading = false;
                }, 300);
              }, 3000);
            } else {
              done();
            }
          }
        }).then(action => {
          this.$message({
            type: 'info',
            message: 'action: ' + action
          });
        });
      },
    }
  }
</script>

:::

Utiliza cadenas HTML

message soporta cadenas HTML.

:::demo Establece el valor de dangerouslyUseHTMLString a true y message sera tratado como una cadena HTML.

<template>
  <el-button type="text" @click="open5">Click to open Message Box</el-button>
</template>

<script>
  export default {
    methods: {
      open5() {
        this.$alert('<strong>This is <i>HTML</i> string</strong>', 'HTML String', {
          dangerouslyUseHTMLString: true
        });
      }
    }
  }
</script>

:::

:::advertencia Aunque la propiedad message soporta cadenas HTML, realizar arbitrariamente render dinamico de HTML en nuestro sitio web puede ser muy peligroso ya que puede conducir facilmente a XSS attacks. Entonces cuando dangerouslyUseHTMLString esta activada, asegurece que el contendio de message sea de confianza, y nunca asignar message a contenido generado por el usuario. :::

Centered content

El contenido del componente MessageBox puede ser centrado.

:::demo Establecer center a true centrara el contenido

<template>
  <el-button type="text" @click="open6">Click to open Message Box</el-button>
</template>

<script>
  export default {
    methods: {
      open6() {
        this.$confirm('This will permanently delete the file. Continue?', 'Warning', {
          confirmButtonText: 'OK',
          cancelButtonText: 'Cancel',
          type: 'warning',
          center: true
        }).then(() => {
          this.$message({
            type: 'success',
            message: 'Delete completed'
          });
        }).catch(() => {
          this.$message({
            type: 'info',
            message: 'Delete canceled'
          });
        });
      }
    }
  }
</script>

:::

Metodos Globales

Si Element fue importado completamente, agregara los siguientes metodos globales para Vue.prototype: $msgbox, $alert, $confirm y $prompt. Asi que en una instancia de Vue puedes llamar el metodo MessageBox como lo que hicimos en esta pagina. Los parametros son:

$msgbox(options)
$alert(message, title, options) or $alert(message, options)
$confirm(message, title, options) or $confirm(message, options)
$prompt(message, title, options) or $prompt(message, options)

Importación local

Si prefieres importar MessageBox cuando lo necesites (on demand):

import { MessageBox } from 'element-ui';

Los metodos correspondientes: MessageBox, MessageBox.alert, MessageBox.confirm y MessageBox.prompt. Los parametros son los mismos que los anteriores.

Opciones

Atributo	Descripción	Tipo	Valores Permitidos	Default
title	titulo del componente MessageBox	string	—	—
message	contenido del componente MessageBox	string	—	—
dangerouslyUseHTMLString	utilizado para que `message` sea tratado como una cadena HTML	boolean	—	false
type	tipo de mensaje , utilizado para mostrar el icono	string	success / info / warning / error	—
customClass	nombre de la clase personzalida para el componente MessageBox	string	—	—
callback	MessageBox callback al cerrar si no deseas utilizar Promise	function(action), donde la accion puede ser 'confirm' o 'cancel', e `instance` es la instancia del componente MessageBox. Puedes acceder a los metodos y atributos de esa instancia	—	—
beforeClose	callback llamado antes de cerrar el componente MessageBox, y previene que el componente MessageBox se cierre	function(action, instance, done), donde `action` pueden ser 'confirm' o 'cancel'; `instance` es la instancia del componente MessageBox, Puedes acceder a los metodos y atributos de esa instancia; `done` es para cerrar la instancia	—	—
lockScroll	utilizado para bloquear el desplazamiento del contenido del MessageBox prompts	boolean	—	true
showCancelButton	utlizado para mostrar un boton cancelar	boolean	—	false (true cuando es llamado con confirm y prompt)
showConfirmButton	utlizado para mostrar un boton confirmar	boolean	—	true
cancelButtonText	contenido de texto del boton cancelar	string	—	Cancel
confirmButtonText	contenido de texto del boton confirmar	string	—	OK
cancelButtonClass	nombre de la clase personalizada del boton cancelar	string	—	—
confirmButtonClass	nombre de la clase personalizada del boton confirmar	string	—	—
closeOnClickModal	utilizado para que que el componenteMessageBox pueda ser cerrado al dar click en la mascara	boolean	—	true (false cuando es llamado con alert)
closeOnPressEscape	utilizado para que que el componenteMessageBox pueda ser cerrado al presionar la tecla ESC	boolean	—	true (false cuando es llamado con alert)
closeOnHashChange	utilizado para cerra el componente MessageBox cuando hash cambie	boolean	—	true
showInput	utilizado para mostrar el componente input	boolean	—	false (true cuando es llamado con prompt)
inputPlaceholder	placeholder para el componente input	string	—	—
inputType	tipo del componente input	string	—	text
inputValue	valor inicial del componente input	string	—	—
inputPattern	regexp del componente input	regexp	—	—
inputValidator	funcion de validacion del componente input. Debe regresar un valor de tipo boolean o string. Si regresa un valor tipo string, sera asignado a inputErrorMessage	function	—	—
inputErrorMessage	mensaje de error cuando la validacion falla	string	—	Illegal input
center	utilizado para alinear el contenido al centro	boolean	—	false
roundButton	utilizado para redondear el boton	boolean	—	false

16 KiB Raw Blame History Unescape Escape