Skip to content

Commit 9a21e7e

Browse files
laFreeFallmosinve
authored andcommitted
Fix typo in Popover docs (bootstrap-vue#1917)
1 parent a058a9a commit 9a21e7e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/directives/tooltip/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -166,13 +166,13 @@ Use both `click` and `blur` if you would like a tooltip that opens only on click
166166
the element, but will close when anything else in the document is clicked or
167167
receives focus.
168168

169-
Note that your elment **must** be in the document tab sequence for this to work. If
169+
Note that your element **must** be in the document tab sequence for this to work. If
170170
your element is not tabable, add the `tabindex="0"` attribute to the element.
171171

172172
## Title content
173-
There are seveal options for providing the title of a tooltip.
173+
There are several options for providing the title of a tooltip.
174174

175-
By default, tooltip will ue the `title` attribute of the element as the
175+
By default, tooltip will use the `title` attribute of the element as the
176176
tooltip content. The title can also be passed as an object to `v-b-tooltip
177177
` in the form of
178178
```js
@@ -244,22 +244,22 @@ Where [modX] can be (all optional):
244244
- Positioning: `top`, `bottom`, `left`, `right`, `auto`, `topleft`, `topright`, `bottomleft`, `bottomright`, `lefttop`, `leftbottom`, `righttop`, or `rightbottom` (last one found wins, defaults to `top`)
245245
- Event trigger: `click`, `hover`, `focus`, `blur` (if none specified, defaults to `focus` and `hover`. `blur` is a close handler only, and if specified by itself, will be converted to `focus`)
246246
- `nofade` to turn off animation
247-
- `html` to enable rendering raw HTML. by default HTML is escaped and converted to text
247+
- `html` to enable rendering raw HTML. By default HTML is escaped and converted to text
248248
- A delay value in the format of `d###` (where `###` is in ms, defaults to 0);
249249
- An offset value in pixels in the format of `o###` (where `###` is the number of pixels, defaults to 0. Negative values allowed)
250250
- A boundary setting of `window` or `viewport`. The element to constrain the visual placement of the tooltip. If not specified, the boundary defaults to the trigger element's scroll parent (in most cases this will suffice).
251251

252252
Where `<value>` can be (optional):
253253
- A string containing the title of the tooltip
254254
- A function reference to generate the title of the tooltip (receives one arg which is a reference to the DOM element triggering the tooltip)
255-
- An object containing more complex configuration of tooltip, See below for accepted object properties:
255+
- An object containing more complex configuration of tooltip. See below for accepted object properties:
256256

257257

258258
**Options configuration object properties:**
259259

260260
| Property | Type | Default | Description
261261
| ---- | ---- | ------- | -----------
262-
| `animation` | boolean | `true` | Apply a CSS fade transition to the tooltip
262+
| `animation` | boolean | `true` | Apply a CSS fade transition to the tooltip.
263263
| `container` | string or Element or `false` | `false` | Appends the tooltip to a specific element. Example: `container: 'body'`. This option is particularly useful in that it allows you to position the tooltip in the flow of the document near the triggering element - which will prevent the tooltip from floating away from the triggering element during a window resize. When set to `false` the tooltip will be appended to `body`, or if the trigger element is inside a modal it will append to the modal's container.
264264
| `delay` | Number or Object | `0` | Delay showing and hiding the tooltip (ms). If a number is supplied, delay is applied to both hide/show. Object structure is: `delay: { "show": 500, "hide": 100 }`
265265
| `html` | Boolean | `false` | Allow HTML in the tooltip. If true, HTML tags in the tooltip's title will be rendered in the tooltip. If false, the titkle will be inserted as plain text. Use text if you're worried about XSS attacks.
@@ -268,7 +268,7 @@ Where `<value>` can be (optional):
268268
| `title` | String or Element or function | `''` | Default title value if title attribute isn't present. If a function is given, it must return a string.
269269
| `trigger` | String | `'hover focus'` | How tooltip is triggered: `click`, `hover`, `focus`. You may pass multiple triggers; separate them with a space.
270270
| `offset` | Number or String | `0` | Offset of the tooltip relative to its target. For more information refer to Popper.js's offset docs.
271-
| `fallbackPlacement` | String or Array | `'flip'` | Allow to specify which position Popper will use on fallback. For more information refer to Popper.js's behavior docs
271+
| `fallbackPlacement` | String or Array | `'flip'` | Allow to specify which position Popper will use on fallback. For more information refer to Popper.js's behavior docs.
272272
| `boundary` | String or HTMLElement reference |`'scrollParent'` | The container that the tooltip will be constrained visually. The default should suffice in most cases, but you may need to chagne this if your target element is in a small container with overflow scroll. Supported values: `'scrollParent'` (default), `'viewport'`, `'window'`, or a reference to an HTML element.
273273

274274

0 commit comments

Comments
 (0)