Skip to content

Commit 044cd7f

Browse files
committed
Docs: missing options and fixes
1 parent 45dd046 commit 044cd7f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,13 @@ Or a reactive property:
173173
- `offset` - Offset of the position (px).
174174
- `container` - Selector: Container where the tooltip will be appended (e.g. `'body'`).
175175
- `boundariesElement` - DOM element for the tooltip boundaries.
176+
- `template` - HTML template of the tooltip.
177+
- `arrowSelector` - CSS selector to get the arrow element in the tooltip template.
178+
- `innerSelector` - CSS selector to get the inner content element in the tooltip template.
176179
- `popperOptions` - Other Popper.js options.
177180

181+
You can change the default values in the [Global options](#global-options).
182+
178183
### Tooltip auto-hiding
179184

180185
By default, if `trigger` contains `'hover'`, the tooltip is automatically hidden on hover or click. To disable this, set the `autoHide` option to `false`:
@@ -269,6 +274,8 @@ By default, the popover will have the `tooltip` and `popover` classes, so you ca
269274
- `autoHide` - Hide the popover if clicked outside.
270275
- `handleResize` - Automatically update the popover position if its size changes.
271276

277+
You can change the default values in the [Global options](#global-options).
278+
272279
**Events:**
273280

274281
- `update:open(Boolean)` - This allow you to use the `.sync` modifier on the `open` prop.
@@ -342,12 +349,14 @@ The default global options are:
342349
You can change the options during install with the arguments:
343350

344351
```javascript
352+
import VTooltip from 'v-tooltip'
345353
Vue.use(VTooltip, options)
346354
```
347355

348356
Or directly on the directive definition:
349357

350358
```javascript
359+
import { VTooltip } from 'v-tooltip'
351360
// Set custom CSS class
352361
VTooltip.options.defaultClass = 'my-tooltip'
353362
```

0 commit comments

Comments
 (0)