mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-14 17:31:02 +08:00
55348b30b6
* style: use prettier * style: just prettier format, no code changes * style: eslint fix object-shorthand, prefer-const * style: fix no-void * style: no-console
274 lines
12 KiB
Markdown
274 lines
12 KiB
Markdown
## Tooltip
|
|
|
|
Mostrar aviso de información con el hover del mouse.
|
|
|
|
### Uso básico
|
|
|
|
Tooltip tiene 9 colocaciones.
|
|
|
|
:::demo Use el atributo `content` para establecer el contenido que se mostrará al hacer hover. El atributo `placement` determina la posición del tooltip. Su valor es `[orientation]-[alignment]` con cuatro orientaciones `top`, `left`, `right`, `bottom` y tres alineaciones `start`, `end`, `null`, la alineación default es null. Tome `placement="left-end"` como ejemplo, Tooltip será mostrado en la izquierda del elemento en que se esté haciendo hover y el fondo del tooltip se alineará con el fondo del elemento.
|
|
|
|
```html
|
|
<div class="box">
|
|
<div class="top">
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Top Left prompts info"
|
|
placement="top-start"
|
|
>
|
|
<el-button>top-start</el-button>
|
|
</el-tooltip>
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Top Center prompts info"
|
|
placement="top"
|
|
>
|
|
<el-button>top</el-button>
|
|
</el-tooltip>
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Top Right prompts info"
|
|
placement="top-end"
|
|
>
|
|
<el-button>top-end</el-button>
|
|
</el-tooltip>
|
|
</div>
|
|
<div class="left">
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Left Top prompts info"
|
|
placement="left-start"
|
|
>
|
|
<el-button>left-start</el-button>
|
|
</el-tooltip>
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Left Center prompts info"
|
|
placement="left"
|
|
>
|
|
<el-button>left</el-button>
|
|
</el-tooltip>
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Left Bottom prompts info"
|
|
placement="left-end"
|
|
>
|
|
<el-button>left-end</el-button>
|
|
</el-tooltip>
|
|
</div>
|
|
|
|
<div class="right">
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Right Top prompts info"
|
|
placement="right-start"
|
|
>
|
|
<el-button>right-start</el-button>
|
|
</el-tooltip>
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Right Center prompts info"
|
|
placement="right"
|
|
>
|
|
<el-button>right</el-button>
|
|
</el-tooltip>
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Right Bottom prompts info"
|
|
placement="right-end"
|
|
>
|
|
<el-button>right-end</el-button>
|
|
</el-tooltip>
|
|
</div>
|
|
<div class="bottom">
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Bottom Left prompts info"
|
|
placement="bottom-start"
|
|
>
|
|
<el-button>bottom-start</el-button>
|
|
</el-tooltip>
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Bottom Center prompts info"
|
|
placement="bottom"
|
|
>
|
|
<el-button>bottom</el-button>
|
|
</el-tooltip>
|
|
<el-tooltip
|
|
class="item"
|
|
effect="dark"
|
|
content="Bottom Right prompts info"
|
|
placement="bottom-end"
|
|
>
|
|
<el-button>bottom-end</el-button>
|
|
</el-tooltip>
|
|
</div>
|
|
</div>
|
|
|
|
<style>
|
|
.box {
|
|
width: 400px;
|
|
|
|
.top {
|
|
text-align: center;
|
|
}
|
|
|
|
.left {
|
|
float: left;
|
|
width: 110px;
|
|
}
|
|
|
|
.right {
|
|
float: right;
|
|
width: 110px;
|
|
}
|
|
|
|
.bottom {
|
|
clear: both;
|
|
text-align: center;
|
|
}
|
|
|
|
.item {
|
|
margin: 4px;
|
|
}
|
|
|
|
.left .el-tooltip__popper,
|
|
.right .el-tooltip__popper {
|
|
padding: 8px 10px;
|
|
}
|
|
|
|
.el-button {
|
|
width: 110px;
|
|
}
|
|
}
|
|
</style>
|
|
```
|
|
|
|
:::
|
|
|
|
### Tema
|
|
|
|
Tooltip tiene dos temas: `dark` y `light`.
|
|
|
|
:::demo Establecer `effect` para modificar el tema, el valor por defecto es `dark`.
|
|
|
|
```html
|
|
<el-tooltip content="Top center" placement="top">
|
|
<el-button>Dark</el-button>
|
|
</el-tooltip>
|
|
<el-tooltip content="Bottom center" placement="bottom" effect="light">
|
|
<el-button>Light</el-button>
|
|
</el-tooltip>
|
|
```
|
|
|
|
:::
|
|
|
|
### Más Contenido
|
|
|
|
Despliegue múltiples líneas de texto y establezca su formato.
|
|
|
|
:::demo Sobrecriba el atributo `content` del `el-tooltip` añadiendo un slot llamado `content`.
|
|
|
|
```html
|
|
<el-tooltip placement="top">
|
|
<template #content> multiple lines<br />second line </template>
|
|
<el-button>Top center</el-button>
|
|
</el-tooltip>
|
|
```
|
|
|
|
:::
|
|
|
|
### Uso Avanzado
|
|
|
|
Adicional a los usos básicos, existen algunos atributos que permiten la personalización:
|
|
|
|
el atributo `transition` permite personalizar la animación con la que el Tooltip se muestra o se esconda, el valor por defecto es `el-fade-in-linear`.
|
|
|
|
el atributo `disabled` permite deshabilitar `tooltip`. Solo es necesario definirlo como `true`.
|
|
|
|
De hecho, Tooltip es una extensión basada en [Vue-popper](https://github.com/element-component/vue-popper), es posible utilizar cualquier atributo permitido en Vue-popper.
|
|
|
|
:::demo
|
|
|
|
```html
|
|
<template>
|
|
<el-tooltip
|
|
:disabled="disabled"
|
|
content="click to close tooltip function"
|
|
placement="bottom"
|
|
effect="light"
|
|
>
|
|
<el-button @click="disabled = !disabled"
|
|
>click to {{disabled ? 'active' : 'close'}} tooltip function</el-button
|
|
>
|
|
</el-tooltip>
|
|
</template>
|
|
|
|
<script>
|
|
export default {
|
|
data() {
|
|
return {
|
|
disabled: false,
|
|
}
|
|
},
|
|
}
|
|
</script>
|
|
|
|
<style>
|
|
.slide-fade-enter-active {
|
|
transition: all 0.3s ease;
|
|
}
|
|
.slide-fade-leave-active {
|
|
transition: all 0.3s cubic-bezier(1, 0.5, 0.8, 1);
|
|
}
|
|
.slide-fade-enter,
|
|
.expand-fade-leave-active {
|
|
margin-left: 20px;
|
|
opacity: 0;
|
|
}
|
|
</style>
|
|
```
|
|
|
|
:::
|
|
|
|
:::tip
|
|
El componente `router-link` no es soportado por Tooltip, favor de usar `vm.$router.push`.
|
|
|
|
Elementos de forma deshabilitados no son soportados por Tooltip, más información puede ser encontrada en [MDN](https://developer.mozilla.org/en-US/docs/Web/Events/mouseenter).
|
|
Es necesario envolver los elementos de forma deshabilitados en un elemento contenedor para que Tooltipo funcione.
|
|
:::
|
|
|
|
### Atributos
|
|
|
|
| Atributo | Descripción | Tipo | Valores aceptados | Por defecto |
|
|
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
|
|
| append-to-body | Si adjuntar el cuadro de diálogo al cuerpo | boolean | — | true |
|
|
| effect | tema del Tooltip | string | dark/light | dark |
|
|
| content | contenido a mostrar, puede ser sobre-escrito por `slot#content` | string | — | — |
|
|
| placement | posición del Tooltip | string | top/top-start/top-end/bottom/bottom-start/bottom-end/left/left-start/left-end/right/right-start/right-end | bottom |
|
|
| model-value / v-model | visibilidad del Tooltip | boolean | — | false |
|
|
| disabled | saber si el Tooltip se encuentra deshabilitado | boolean | — | false |
|
|
| offset | offset del Tooltip | number | — | 0 |
|
|
| transition | nombre de animación | string | — | el-fade-in-linear |
|
|
| visible-arrow | si una flecha es mostrada. Para mayor información, revisar la página de [Vue-popper](https://github.com/element-component/vue-popper) | boolean | — | true |
|
|
| popper-options | parámetros de [popper.js](https://popper.js.org/documentation.html) | Object | referirse a la documentación de [popper.js](https://popper.js.org/documentation.html) | `{ boundariesElement: 'body', gpuAcceleration: false }` |
|
|
| show-after | retraso de la apariencia, en milisegundos | number | — | 0 |
|
|
| hide-after | retraso en el cierre, en milisegundos | number | — | 0 |
|
|
| auto-close | tiempo a esperar en milisegundos para esconder el Tooltip | number | — | 0 |
|
|
| manual | si el Tooltipo será controlado de forma manual. `mouseenter` y `mouseleave` no tendrán efecto si fue establecido como `true` | boolean | — | false |
|
|
| popper-class | nombre de clase personalizada para el popper del Tooltip | string | — | — |
|
|
| enterable | si el mouse puede entrar al Tooltip | Boolean | — | true |
|
|
| tabindex | [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of Tooltip | number | — | 0 |
|