Files
flowbite-vue/docs/components/tooltip.md
Ilya Artamonov d316cf3a12 Components renaming (#225)
* refactor: eslint config adjusted for better diff's

* refactor: stricter linting
 + dependencies updated

* refactoring: paragraph component
 - component
 - docs

* refactoring: heading component
 - component
 - docs

* Update docs/components/heading.md

Co-authored-by: Ilya Artamonov <ilya.sosidka@gmail.com>

* refactoring: link component
 - component
 - docs

* refactoring: image component
 - component
 - docs

* refactoring: alert component
 - component
 - docs

* refactoring: avatar component
 - component
 - docs

* refactoring: removed unnecessary code
    - component names come from the file name

* refactoring: breadcrumb component
 - component
 - docs

* refactoring: accordion component
 - component
 - docs

* refactoring: buttom component
 - component
 - docs

* refactoring: badge component
 - component
 - docs

* refactoring: card component
 - component
 - docs

* refactoring: order of components in docs updated

* refactoring: unnecessary semicolons removed

* refactoring: button group component
 - component
 - docs

* refactoring: carousel component
 - component
 - docs

* refactoring: dropdown component
 - component
 - docs

* refactoring: footer component
 - component
 - docs

* refactoring:list-group component
 - component
 - docs

* refactoring: modal component
 - component
 - docs

* refactoring: navbar component
 - component
 - docs

* refactoring: pagination component
 - component
 - docs

* refactoring: progress component
 - component
 - docs

* refactoring: rating component
 - component
 - docs

* refactoring: spinner component
 - component
 - docs

* refactoring: table component
 - component
 - docs

* refactoring: tabs component
 - component
 - docs

* feat: Updated pagination examples

* lint: Lister fixes

* feat: Sidebar component and some fixes

* feat: Input component

* feat: Some fixes

* feat: Some fixes

* chore: update deps

* refactor: removed old Modal component

* refactor: radio component and some fixes

* fix: fixed path error

* refactor: Range component

* refactoring: timeline component
 - component
 - docs

* refactor: Select component

* refactoring: toast component
 - component
 - docs

* refactoring: tooltip component
 - component
 - docs

* refactoring: sidebar component
 - component
 - docs

* refactoring: input component
 - component
 - docs

* refactoring: fileInput component
 - component
 - docs

* refactoring: select component
 - component
 - docs

* refactoring: textarea component
 - component
 - docs

* refactoring: checkbox component
 - component
 - docs

* refactoring: radio component
 - component
 - docs

* refactoring: toggle component
 - component
 - docs

* refactoring: range component
 - component
 - docs

* local configs linted

* documentation quick start updated

* flowbite-themable refactored to fit new linters and style guide

* random linter fixes

* refactoring: toast-provider component
 - component
 - docs

* final linter fixes

* lint: Linter fixes

* fix: Fixed types

* fix: Fixed card component

* docs: Updated card examples

* fix: Fixed tabs

* refactor: Heading component refactoring

* Fwb rename - few fixes after component review (#237)

* fix: button documentation

* fix: model type in range examples

* chore: Toast marked as WIP

---------

Co-authored-by: Sqrcz <naorniakowski@slashlab.pl>
Co-authored-by: Sqrcz <naorniakowski@gmail.com>
2023-10-23 18:23:14 +03:00

155 lines
3.6 KiB
Markdown

<script setup>
import FwbTooltipExample from './tooltip/examples/FwbTooltipExample.vue'
import FwbTooltipExamplePosition from './tooltip/examples/FwbTooltipExamplePosition.vue'
import FwbTooltipExampleStyle from './tooltip/examples/FwbTooltipExampleStyle.vue'
import FwbTooltipExampleTrigger from './tooltip/examples/FwbTooltipExampleTrigger.vue'
</script>
# Vue Tooltip - Flowbite
## Demo
<fwb-tooltip-example />
```vue
<template>
<fwb-tooltip>
<template #trigger>
<fwb-button>
Default Tooltip
</fwb-button>
</template>
<template #content>
Tooltip content
</template>
</fwb-tooltip>
</template>
<script setup>
import { FwbButton, FwbTooltip } from 'flowbite-vue'
</script>
```
## Tooltip styles
You can use choose between dark and light version styles for the tooltip component by changing the utility classes from Tailwind CSS and by applying the `tooltip-light` or `tooltip-dark` attribute.
<fwb-tooltip-example-style />
```vue
<template>
<fwb-tooltip theme="light">
<template #trigger>
<fwb-button>
Light Tooltip
</fwb-button>
</template>
<template #content>
Tooltip content
</template>
</fwb-tooltip>
<fwb-tooltip theme="dark">
<template #trigger>
<fwb-button>
Dark Tooltip
</fwb-button>
</template>
<template #content>
Tooltip content
</template>
</fwb-tooltip>
</template>
<script setup>
import { FwbButton, FwbTooltip } from 'flowbite-vue'
</script>
```
## Placement
The positioning of the tooltip element relative to the triggering element (eg. button, link) can be set using placement attribute with `top`, `top-start` , `top-end`, `bottom`, `bottom-start`, `bottom-end`, `right`, `right-start`, `right-end`, `left`, `left-start`, `left-end`, `auto`, `auto-start`, `auto-end`.
The default value is: `top`
<fwb-tooltip-example-position />
```vue
<template>
<fwb-tooltip placement="top">
<template #trigger>
<fwb-button>
Tooltip top
</fwb-button>
</template>
<template #content>
Tooltip on top
</template>
</fwb-tooltip>
<fwb-tooltip placement="right">
<template #trigger>
<fwb-button>
Tooltip right
</fwb-button>
</template>
<template #content>
Tooltip on right
</template>
</fwb-tooltip>
<fwb-tooltip placement="bottom">
<template #trigger>
<fwb-button>
Tooltip bottom
</fwb-button>
</template>
<template #content>
Tooltip on bottom
</template>
</fwb-tooltip>
<fwb-tooltip placement="left">
<template #trigger>
<fwb-button>
Tooltip left
</fwb-button>
</template>
<template #content>
Tooltip on left
</template>
</fwb-tooltip>
</template>
<script setup>
import { FwbButton, FwbTooltip } from 'flowbite-vue'
</script>
```
## triggerType
You can choose the triggering event by using the `hover` or `click` attributes to choose whether you want to show the tooltip when hovering or clicking on the element. By default this option is set to `click`.
<fwb-tooltip-example-trigger />
```vue
<template>
<fwb-tooltip>
<template #trigger>
<fwb-button>
Tooltip hover
</fwb-button>
</template>
<template #content>
Tooltip content
</template>
</fwb-tooltip>
<fwb-tooltip trigger="click">
<template #trigger>
<fwb-button>
Tooltip click
</fwb-button>
</template>
<template #content>
Tooltip content
</template>
</fwb-tooltip>
</template>
<script lang="ts" setup>
import { FwbButton, FwbTooltip } from 'flowbite-vue'
</script>
```