Message Box

Un conjunto de cajas modales simulando un sistema de message box, principalmente para alertar información, confirmar operaciones y mostrar mensajes de aviso.

TIP

Por diseño, MessageBox proporciona simulaciones de alert del sistema, confirm y prompt, por lo que su contenido debería ser simple. Para contenido más complejo, por favor utilice el componente Dialog.

Alerta

La alerta interrumpe la operación del usuario hasta que el usuario lo confirme.

Confirmación

Confirm es utilizado para preguntar al usuario y recibir una confirmación.

Preguntar

Prompt es utilizado cuando se requiere entrada de información del usuario.

Use VNode

mensaje puede ser VNode.

Personalización

Se puede personalizar para mostrar varios contenidos.

Usando cadenas HTML

mensaje soporta cadena HTML.

WARNING

Aunque la propiedad message soporta cadenas HTML, renderizando HTML arbitrario en su sitio web puede ser muy peligroso porque puede llevar fácilmente a ataques XSS. Así que cuando peligouslyUseHTMLString esté encendido, por favor asegúrese de que el contenido del menssage es de confianza, y nunca asigne menssage al contenido proporcionado por el usuario.

Distinguir entre cancelar y cerrar

En algunos casos, hacer clic en el botón cancelar y cerrar puede tener diferentes significados.

Contenido centrado

El contenido de MessageBox se puede centrar.

Icono personalizado

El icono se puede personalizar a cualquier componente Vue o función de renderizado (JSX).

Draggable

MessageBox puede ser arrastrable.

Métodos Globales

Si Element Plus se importa completamente, se añadirán los siguientes métodos globales para app.config.globalProperties: $msgbox, $alert, $confirm y $prompt. Así que en una instancia de Vue puede llamar a MessageBox como lo que hicimos en esta página. Los parámetros 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)

Herencia de contexto de aplicación > 2.0.4

Ahora el cuadro de mensaje acepta un context como segundo (cuarto si está usando variantes del cuadro de mensajes) parámetro del constructor de mensajes que le permite inyectar el contexto de la aplicación actual al mensaje que le permite heredar todas las propiedades de la aplicación.

import { getCurrentInstance } from 'vue'
import { ElMessageBox } from 'element-plus'

// in your setup method
const { appContext } = getCurrentInstance()!
// You can pass it like:
ElMessageBox({}, appContext)
// or if you are using variants
ElMessageBox.alert('Hello world!', 'Title', {}, appContext)

Importación local

Si prefiere importar MessageBox bajo demanda:

import { ElMessageBox } from 'element-plus'

Los métodos correspondientes son: ElMessageBox, ElMessageBox.alert, ElMessageBox.confirm y ElMessageBox.prompt. Los parámetros son los mismos que los anteriores.

API

Options

NameDescripciónTipoDefault
autofocusautofocalización al abrir MessageBoxbooleantrue
titletítulo del componente MessageBoxstring''
messagecontenido del componente MessageBoxstring / VNode / Function 2.2.17
dangerouslyUseHTMLStringutilizado para que message sea tratado como cadena HTMLbooleanfalse
typetipo de mensaje, utilizado para mostrar el iconoenum''
iconcomponente de icono personalizado, sobreescribe typestring / Component''
custom-classnombre de la clase personalizada para el componente MessageBoxstring''
custom-styleestilo en línea personalizado para MessageBoxCSSProperties{}
callbackFunción de callback al cerrar MessageBox si no desea utilizar PromiseFunctionnull
showClosesi desea mostrar el icono cerrar de MessageBoxbooleantrue
before-closeuna función callback antes de que se cierre el MessageBox, y con esto se pueden tomar previsiones al cierre, incluso evitar que el cuadro pueda ser cerradoFunctionnull
distinguish-cancel-and-closesi distinguir cancelar y cerrar el MessageBoxbooleanfalse
lock-scrollsi bloquear el desplazamiento del cuerpobooleantrue
show-cancel-buttonsi desea mostrar un botón de cancelarbooleanfalse (true when called with confirm and prompt)
show-confirm-buttonsi desea mostrar un botón de confirmarbooleantrue
cancel-button-textcontenido de texto del botón cancelarstringCancel
confirm-button-textcontenido de texto del botón confirmarstringOK
cancel-button-classnombre de la clase personalizada del botón cancelarstring''
confirm-button-classnombre de la clase personalizada del botón confirmarstring''
close-on-click-modalsi MessageBox puede cerrarse haciendo clic en la máscarabooleantrue (false when called with alert)
close-on-press-escapesi MessageBox puede cerrarse presionando el ESCbooleantrue (false when called with alert)
close-on-hash-changesi cerrar MessageBox cuando el hash cambiebooleantrue
show-inputsi desea mostrar un inputbooleanfalse (true when called with prompt)
input-placeholderplaceholder del inputstring''
input-typetipo de inputstringtext
input-valuevalor inicial del inputstringnull
input-patternregexp para el inputregexpnull
input-validatorfunción de validación del input. Debe regresar un valor de tipo boolean o string. Si regresa un valor tipo string, será asignado a inputErrorMessageFunctionnull
input-error-messagemensaje de error cuando la validación fallastringIllegal input
centersi centrar el contenidobooleanfalse
draggablesi MessageBox es arrastrablebooleanfalse
overflow 2.5.4draggable MessageBox can overflow the viewportbooleanfalse
round-buttonsi usar los botones redondosbooleanfalse
button-sizetamaño personalizado de botones de confirmación y cancelaciónstringdefault
append-to 2.2.19establecer el elemento raíz para el message boxstring / HTMLElement

Fuente

ComponentesDocumentación

Contribuidores