Skip to content

Commit

Permalink
Docs: missing options and fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Akryum committed Nov 23, 2017
1 parent 45dd046 commit 044cd7f
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,13 @@ Or a reactive property:
- `offset` - Offset of the position (px).
- `container` - Selector: Container where the tooltip will be appended (e.g. `'body'`).
- `boundariesElement` - DOM element for the tooltip boundaries.
- `template` - HTML template of the tooltip.
- `arrowSelector` - CSS selector to get the arrow element in the tooltip template.
- `innerSelector` - CSS selector to get the inner content element in the tooltip template.
- `popperOptions` - Other Popper.js options.

You can change the default values in the [Global options](#global-options).

### Tooltip auto-hiding

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

You can change the default values in the [Global options](#global-options).

**Events:**

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

```javascript
import VTooltip from 'v-tooltip'
Vue.use(VTooltip, options)
```

Or directly on the directive definition:

```javascript
import { VTooltip } from 'v-tooltip'
// Set custom CSS class
VTooltip.options.defaultClass = 'my-tooltip'
```
Expand Down

0 comments on commit 044cd7f

Please sign in to comment.