2017-11-06 19:22:02 +08:00
## Alert
2017-11-08 14:22:06 +08:00
Mostrar mensajes de alertas importantes.
2017-11-06 19:22:02 +08:00
2017-11-08 14:22:06 +08:00
### Uso básico
2017-11-06 19:22:02 +08:00
2017-11-08 14:22:06 +08:00
Los componentes de alertas no son elementos overlay de la página y no desaparecen automáticamente.
2017-11-06 19:22:02 +08:00
2017-12-12 12:45:09 +08:00
:::demo Alert provee 4 tipos de temas definidos por `type` , el valor por defecto es `info` .
2017-11-06 19:22:02 +08:00
```html
< template >
< el-alert
title="success alert"
type="success">
< / el-alert >
< el-alert
title="info alert"
type="info">
< / el-alert >
< el-alert
title="warning alert"
type="warning">
< / el-alert >
< el-alert
title="error alert"
type="error">
< / el-alert >
< / template >
```
:::
2017-12-03 18:03:06 +08:00
### Personalización del botón de cerrar
2017-11-06 19:22:02 +08:00
2017-12-03 18:03:06 +08:00
Personalizar el botón de cerrar como texto u otros símbolos.
2017-11-08 14:22:06 +08:00
2017-12-12 12:45:09 +08:00
:::demo Alert permite configurar si es posible cerrarla. El texto del botón de cerrado, así como los callbacks de cerrado son personalizables. El atributo `closable` define si el componente puede cerrarse o no. Acepta un `boolean` , que por defecto es `true` . También puede configurar el atributo `close-text` para reemplazar el símbolo de cerrado que se muestra por defecto. El atributo `close-text` debe ser un string. El evento `close` se dispara cuando el componente se cierra.
2017-11-06 19:22:02 +08:00
```html
< template >
< el-alert
title="unclosable alert"
type="success"
:closable="false">
< / el-alert >
< el-alert
title="customized close-text"
type="info"
close-text="Gotcha">
< / el-alert >
< el-alert
title="alert with callback"
type="warning"
@close ="hello">
< / el-alert >
< / template >
< script >
export default {
methods: {
hello() {
alert('Hello World!');
}
}
}
< / script >
```
:::
2017-11-08 14:22:06 +08:00
### Usar iconos
Mostrar un icono mejora la legibilidad.
2017-11-06 19:22:02 +08:00
2017-12-12 12:45:09 +08:00
:::demo Setear el atributo `show-icon` muestra un icono que corresponde al tipo de Alert que se está mostrando.
2017-11-06 19:22:02 +08:00
```html
< template >
< el-alert
title="success alert"
type="success"
show-icon>
< / el-alert >
< el-alert
title="info alert"
type="info"
show-icon>
< / el-alert >
< el-alert
title="warning alert"
type="warning"
show-icon>
< / el-alert >
< el-alert
title="error alert"
type="error"
show-icon>
< / el-alert >
< / template >
```
:::
2017-11-08 14:22:06 +08:00
### Texto centrado
2017-11-06 19:22:02 +08:00
2017-11-08 14:22:06 +08:00
Para centrar el texto utilice el atributo `center` .
2017-11-06 19:22:02 +08:00
2017-12-12 12:45:09 +08:00
:::demo
2017-11-06 19:22:02 +08:00
```html
< template >
< el-alert
title="success alert"
type="success"
center
show-icon>
< / el-alert >
< el-alert
title="info alert"
type="info"
center
show-icon>
< / el-alert >
< el-alert
title="warning alert"
type="warning"
center
show-icon>
< / el-alert >
< el-alert
title="error alert"
type="error"
center
show-icon>
< / el-alert >
< / template >
```
:::
2017-11-08 14:22:06 +08:00
### Con descripción
2017-11-06 19:22:02 +08:00
2017-11-08 14:22:06 +08:00
Descripción incluye un mensaje con información más detallada.
2017-11-06 19:22:02 +08:00
2017-12-12 12:45:09 +08:00
:::demo Además del atributo requerido `title` , se puede agregar el atributo `description` para ayudar a describir la alerta con mas detalles. La descripción puede contener solamente un string y va a usar word wrap automáticamente.
2017-11-06 19:22:02 +08:00
```html
< template >
< el-alert
title="with description"
type="success"
description="This is a description.">
< / el-alert >
< / template >
```
:::
2017-11-08 14:22:06 +08:00
### Utilizando icono y descripción
2017-11-06 19:22:02 +08:00
2017-12-12 12:45:09 +08:00
:::demo Finalmente este es un ejemplo utilizando icono y descripción.
2017-11-06 19:22:02 +08:00
```html
< template >
< el-alert
title="success alert"
type="success"
description="more text description"
show-icon>
< / el-alert >
< el-alert
title="info alert"
type="info"
description="more text description"
show-icon>
< / el-alert >
< el-alert
title="warning alert"
type="warning"
description="more text description"
show-icon>
< / el-alert >
< el-alert
title="error alert"
type="error"
description="more text description"
show-icon>
< / el-alert >
< / template >
```
:::
2017-11-08 14:22:06 +08:00
### Atributos
2017-12-03 18:03:06 +08:00
| Atributo | Descripción | Tipo | Valores aceptados | Por defecto |
| ----------- | ---------------------------------------- | ------- | -------------------------- | ----------- |
2018-11-09 12:01:35 +08:00
| title | título | string | — | — |
2017-12-03 18:03:06 +08:00
| type | tipo de componente | string | success/warning/info/error | info |
| description | texto descriptivo. También puede ser pasado con el slot por defecto | string | — | — |
| closable | si se puede cerrar o no | boolean | — | true |
| center | si el texto debe estar centrado | boolean | — | false |
| close-text | texto de cerrado personalizado | string | — | — |
| show-icon | si un icono del tipo de alerta se debe mostrar | boolean | — | false |
2017-11-06 19:22:02 +08:00
2018-10-20 11:51:36 +08:00
### Slot
| Name | Description |
|------|--------|
| title | El contenido del título de alerta. |
2017-11-06 19:22:02 +08:00
2017-11-08 14:22:06 +08:00
### Eventos
2017-12-03 18:03:06 +08:00
| Nombre del evento | Descripción | Parámetros |
| ----------------- | ------------------------------------- | ---------- |
| close | Se dispara cuando la alerta se cierra | — |