# Tooltip 文字提示

常用于展示鼠标 hover 时的提示信息。

# 基础用法

在这里我们提供 9 种不同方向的展示方式,可以通过以下完整示例来理解,选择你要的效果。

使用content属性来决定hover时的提示信息。由placement属性决定展示效果:placement属性值为:方向-对齐位置;四个方向:topleftrightbottom;三种对齐位置:start, end,默认为空。如placement="left-end",则提示信息出现在目标元素的左侧,且提示信息的底部与目标元素的底部对齐。

<template>
  <div class="box">
    <div class="top">
      <jp-tooltip class="item" effect="dark" content="Top Left 提示文字" placement="top-start">
        <jp-button>上左</jp-button>
      </jp-tooltip>
      <jp-tooltip class="item" effect="dark" content="Top Center 提示文字" placement="top">
        <jp-button>上边</jp-button>
      </jp-tooltip>
      <jp-tooltip class="item" effect="dark" content="Top Right 提示文字" placement="top-end">
        <jp-button>上右</jp-button>
      </jp-tooltip>
    </div>
    <div class="left">
      <jp-tooltip class="item" effect="dark" content="Left Top 提示文字" placement="left-start">
        <jp-button>左上</jp-button>
      </jp-tooltip>
      <jp-tooltip class="item" effect="dark" content="Left Center 提示文字" placement="left">
        <jp-button>左边</jp-button>
      </jp-tooltip>
      <jp-tooltip class="item" effect="dark" content="Left Bottom 提示文字" placement="left-end">
        <jp-button>左下</jp-button>
      </jp-tooltip>
    </div>

    <div class="right">
      <jp-tooltip class="item" effect="dark" content="Right Top 提示文字" placement="right-start">
        <jp-button>右上</jp-button>
      </jp-tooltip>
      <jp-tooltip class="item" effect="dark" content="Right Center 提示文字" placement="right">
        <jp-button>右边</jp-button>
      </jp-tooltip>
      <jp-tooltip class="item" effect="dark" content="Right Bottom 提示文字" placement="right-end">
        <jp-button>右下</jp-button>
      </jp-tooltip>
    </div>
    <div class="bottom">
      <jp-tooltip class="item" effect="dark" content="Bottom Left 提示文字" placement="bottom-start">
        <jp-button>下左</jp-button>
      </jp-tooltip>
      <jp-tooltip class="item" effect="dark" content="Bottom Center 提示文字" placement="bottom">
        <jp-button>下边</jp-button>
      </jp-tooltip>
      <jp-tooltip class="item" effect="dark" content="Bottom Right 提示文字" placement="bottom-end">
        <jp-button>下右</jp-button>
      </jp-tooltip>
    </div>
  </div>
</template>

<style scoped lang="scss">
.box {
  width: 400px;

  .top {
    text-align: center;
  }

  .left {
    float: left;
    width: 60px;
  }

  .right {
    float: right;
    width: 60px;
  }

  .bottom {
    clear: both;
    text-align: center;
  }

  .item {
    margin: 4px;
  }

  .left .jp-tooltip__popper,
  .right .jp-tooltip__popper {
    padding: 8px 10px;
  }
}
</style>
显示代码

# 主题

Tooltip 组件提供了两个不同的主题:darklight

通过设置effect属性来改变主题,默认为dark

<template>
  <div>
    <jp-tooltip content="Top center" placement="top">
      <jp-button>Dark</jp-button>
    </jp-tooltip>
    <jp-tooltip content="Bottom center" placement="bottom" effect="light">
      <jp-button>Light</jp-button>
    </jp-tooltip>
  </div>
</template>
显示代码

# 更多 Content

展示多行文本或者是设置文本内容的格式

用具名 slot分发content,替代tooltip中的content属性。

<template>
  <jp-tooltip placement="top">
    <div slot="content">
      多行信息
      <br />
      第二行信息
    </div>
    <jp-button>Top center</jp-button>
  </jp-tooltip>
</template>
显示代码

# Attributes

参数 说明 类型 可选值 默认值
effect 默认提供的主题 String dark/light dark
content 显示的内容,也可以通过 slot#content 传入 DOM String
placement Tooltip 的出现位置 String top/top-start/top-end/bottom/bottom-start/bottom-end/left/left-start/left-end/right/right-start/right-end bottom
value / v-model 状态是否可见 Boolean false
disabled Tooltip 是否可用 Boolean false
offset 出现位置的偏移量 Number 0
transition 定义渐变动画 String jp-fade-in-linear
visible-arrow 是否显示 Tooltip 箭头,更多参数可见Vue-popper (opens new window) Boolean true
popper-options popper.js (opens new window) 的参数 Object 参考 popper.js (opens new window) 文档 { boundariesElement: 'body', gpuAcceleration: false }
open-delay 延迟出现,单位毫秒 Number 0
manual 手动控制模式,设置为 true 后,mouseenter 和 mouseleave 事件将不会生效 Boolean false
popper-class 为 Tooltip 的 popper 添加类名 String
enterable 鼠标是否可进入到 tooltip 中 Boolean true
hide-after Tooltip 出现后自动隐藏延时,单位毫秒,为 0 则不会自动隐藏 number 0
tabindex Tooltip 组件的 tabindex (opens new window) number 0