diff --git a/packages/devui-vue/docs/en-US/components/tooltip/index.md b/packages/devui-vue/docs/en-US/components/tooltip/index.md new file mode 100644 index 0000000000000000000000000000000000000000..495cfc222d1b288715579ccc7b7da1cb3a94a780 --- /dev/null +++ b/packages/devui-vue/docs/en-US/components/tooltip/index.md @@ -0,0 +1,82 @@ +# Tooltip + +Text notification. + +### When To Use +When users move the cursor to a text, they can see what should do next. + +### Basic Usage + +:::demo + +```vue + + +``` + +::: + +### Delay Trigger + +This event is triggered only when the mouse pointer is moved in for more than [mouseEnterDelay] milliseconds. The default value is 150 ms to prevent flashing caused by unintentional strokes. The toolTip component is hidden only after [mouseLeaveDelay] milliseconds after the cursor is moved out. The default value is 100 milliseconds. + +:::demo + +```vue + +``` + +::: + +### API + +Tooltip parameter + +| Parameter | Type | Default | Description | Jump to Demo | Global Config | +| :-------------: | :----------------------------: | :--------------------------------: | :------------------------------------------------ | --------------------- | ---------- | +| content | `string\|DOMString` | -- | Required. Tooltip display content | [Basic Usage](#basic-usage) | | +| position | `PositionType\|PositionType[]` | ['top', 'right', 'bottom', 'left'] | Optional. Tooltip display position | [Basic Usage](#basic-usage) | | +| showAnimation | `boolean` | true | Optional. Whether to display the drawing animation | | ✔ | +| mouseEnterDelay | `number` | 150 | Optional. Delay for displaying Tooltip after the mouse is enter. The unit is ms | [Delay Trigger](#delay-trigger) | +| mouseLeaveDelay | `number` | 100 | Optional. Delay for hiding Tooltip after the mouse is leave, The unit is ms | [Delay Trigger](#delay-trigger) |