Skip to content
This repository was archived by the owner on Sep 28, 2024. It is now read-only.

fix(docs): README typos #2

Closed
wants to merge 1 commit into from
Closed

fix(docs): README typos #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Alternatively, you may install the component directly within a single file in yo

Import the tooltip component after importing Vue in your file after importing Vue. Installing via CDN does not allow for customizing [Plugin Options](#options).

Installing via the CDN requires using the kebob-case component name.
Installing via the CDN requires using the kebab-case component name.

```html
<!-- Import Vue -->
Expand All @@ -133,7 +133,7 @@ Installing via the CDN requires using the kebob-case component name.

Download `dist/vue-custom-tooltip.min.js` and include it in your file after importing Vue. Installing manually does not allow for customizing [Plugin Options](#options).

Installing manually requires using the kebob-case component name.
Installing manually requires using the kebab-case component name.

```html
<!-- Import Vue -->
Expand Down Expand Up @@ -177,29 +177,29 @@ Pass any of the options listed below to `Vue.use(VueCustomTooltip, {...})` to cu
- Type: `String`
- Default: `VueCustomTooltip`

Customize the name of the component you will use in your project. **Camel-case names are preferred**, as this allows for camel-case or kebob-case usage within your project.
Customize the name of the component you will use in your project. **Pascal-case names are preferred**, as this allows for pascal-case or kebab-case usage within your project.

```js
Vue.use(VueCustomTooltip, {
name: 'SuperCoolTooltip', // camel-case preferred
name: 'SuperCoolTooltip', // pascal-case preferred
})
```

If you registered the name using camel-case, you can reference the tooltip component via camel-case _or_ kebob-case:
If you registered the name using pascal-case, you can reference the tooltip component via pascal-case _or_ kebab-case:

```html
<!-- Default name (user did not pass the 'name' option) -->

<!-- camel-case -->
<!-- pascal-case -->
Nice <VueCustomTooltip label="Neat!">tooltip</VueCustomTooltip>!
<!-- kebob-case -->
<!-- kebab-case -->
Nice <vue-custom-tooltip label="Neat!">tooltip</vue-custom-tooltip>!

<!-- Custom name (allows user to rename component) -->

<!-- camel-case -->
<!-- pascal-case -->
Nice <SuperCoolTooltip label="Neat!">tooltip</SuperCoolTooltip>!
<!-- kebob-case -->
<!-- kebab-case -->
Nice <super-cool-tooltip label="Neat!">tooltip</super-cool-tooltip>!
```

Expand Down