Skip to content

Commit 9959deb

Browse files
committed
docs: improve clarity and consistency in documentation wording
1 parent 1893633 commit 9959deb

22 files changed

+139
-140
lines changed

docs/guide/advanced/layers-and-hooks.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ outline: deep
44

55
# Nuxt Layers and Module Hooks
66

7-
You can load your Vuetify configuration using [Nuxt Layers](https://nuxt.com/docs/getting-started/layers#layers) or using a custom module via `vuetify:registerModule` [Nuxt Module Hook](https://nuxt.com/docs/guide/going-further/hooks#nuxt-hooks-build-time).
7+
You can load your Vuetify configuration using [Nuxt Layers](https://nuxt.com/docs/getting-started/layers#layers) or a custom module via the `vuetify:registerModule` [Nuxt Module Hook](https://nuxt.com/docs/guide/going-further/hooks#nuxt-hooks-build-time).
88

99
## Nuxt Layers
1010

11-
Follow the [installation instructions](/guide/) for `vuetify-nuxt-module` in your layer. Then extend that layer in your other project:
11+
Follow the [installation instructions](/guide/) for `vuetify-nuxt-module` in your layer. Then, you can extend that layer in your other project:
1212
::: code-group
1313

1414
```ts [nuxt.config.ts]
@@ -23,7 +23,7 @@ export default defineNuxtConfig({
2323

2424
## Nuxt Module Hook
2525

26-
You can use a custom module to load your Vuetify configuration:
26+
You can also use a custom module to load your Vuetify configuration:
2727
::: code-group
2828

2929
```ts [nuxt.config.ts]
@@ -36,7 +36,7 @@ export default defineNuxtConfig({
3636

3737
:::
3838

39-
and your module will load your configuration via `vuetify:registerModule` Nuxt hook:
39+
and your module will load your configuration via the `vuetify:registerModule` Nuxt hook:
4040
::: code-group
4141

4242
```ts [modules/my-vuetify-module.ts]

docs/guide/advanced/locale-messages.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Vuetify Locale Messages
22

3-
You can load [Vuetify Locale Messages](https://vuetifyjs.com/en/features/internationalization/#getting-started) using the `vuetifyOptions.localeMessages` module configuration option, you don't need to configure a Nuxt Plugin with the `vuetify:before-create` hook, the module will import them for you, it has been declared properly to have better DX.
3+
You can load [Vuetify Locale Messages](https://vuetifyjs.com/en/features/internationalization/#getting-started) using the `vuetifyOptions.localeMessages` module configuration option. There is no need to configure a Nuxt Plugin with the `vuetify:before-create` hook; the module will import them automatically for a better developer experience.
44

55
::: warning
6-
When `@nuxtjs/i18n` Nuxt module is present, `vuetifyOptions.localeMessages` module configuration option will be ignored.
6+
When the `@nuxtjs/i18n` Nuxt module is present, the `vuetifyOptions.localeMessages` module configuration option will be ignored.
77
:::
88

9-
Using the example in [Vuetify I18n](https://vuetifyjs.com/en/features/internationalization/#getting-started) documentation:
9+
Using the example from the [Vuetify I18n](https://vuetifyjs.com/en/features/internationalization/#getting-started) documentation:
1010
::: code-group
1111

1212
```ts [nuxt.config.ts]
@@ -34,9 +34,9 @@ export default defineNuxtConfig({
3434

3535
:::
3636

37-
Previous configuration will load and configure `zhHans` and `pl` Vuetify messages.
37+
The above configuration will load and configure `zhHans` and `pl` Vuetify messages.
3838

39-
If you have more messages than the default ones provided by Vuetify, you can add them to the locale messages entry or add them adding a new Nuxt plugin registering them in the `vuetify:before-create` hook (remember to merge the messages).
39+
If you have additional messages beyond the default ones provided by Vuetify, you can add them to the locale messages entry or include them by creating a new Nuxt plugin and registering them in the `vuetify:before-create` hook (remembering to merge the messages).
4040

4141
Following with the Vuetify example:
4242
::: code-group
@@ -71,9 +71,9 @@ export default defineNuxtConfig({
7171

7272
:::
7373

74-
This module will merge the messages for you, so you don't need to worry about it.
74+
This module will merge the messages automatically, so you don't need to worry about manual merging.
7575

76-
If you want to load your custom messages from a Nuxt Plugin:
76+
If you prefer to load your custom messages from a Nuxt Plugin:
7777
::: code-group
7878

7979
```ts [plugins/vuetify-i18n.ts]

docs/guide/advanced/runtime-hooks.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Nuxt Runtime Hooks
22

3-
This module configures and registers Vuetify using Nuxt plugins via `vuetify:configuration` runtime hook.
3+
This module configures and registers Vuetify using Nuxt plugins via the `vuetify:configuration` runtime hook.
44

5-
`vuetify:configuration` hook is for internal use and not meant to be used by third-party plugins or directly from your application.
6-
This module will expose only the necessary Nuxt plugins to configure Vuetify using the options you've configured in your application:
7-
- [icons](/guide/features/icons/): this Nuxt plugin is always registered, you can write your own Nuxt plugin via `vuetifyOptions.icons.defaultSet = 'custom'` Nuxt configuration option, you have an example using UnoCSS in [Adding a new Vuetify icon set](/guide/features/icons/unocss-preset-icons#adding-a-new-vuetify-icon-set), replace the icons with your custom ones.
8-
- [i18n](/guide/features/i18n): this Nuxt plugin will be only registered when `@nuxtjs/i18n` module is configured.
9-
- [date](/guide/features/date): this Nuxt plugin will be only registered when `vuetifyOptions.date` Nuxt configuration option is configured.
5+
The `vuetify:configuration` hook is intended for internal use and should not be used by third-party plugins or directly from your application.
6+
This module exposes only the necessary Nuxt plugins to configure Vuetify based on the options you've set in your application:
7+
- [icons](/guide/features/icons/): This Nuxt plugin is always registered. You can write your own Nuxt plugin via the `vuetifyOptions.icons.defaultSet = 'custom'` Nuxt configuration option. An example using UnoCSS can be found in [Adding a new Vuetify icon set](/guide/features/icons/unocss-preset-icons#adding-a-new-vuetify-icon-set), where you can replace the icons with your custom ones.
8+
- [i18n](/guide/features/i18n): This Nuxt plugin is registered only when the `@nuxtjs/i18n` module is configured.
9+
- [date](/guide/features/date): This Nuxt plugin is registered only when the `vuetifyOptions.date` Nuxt configuration option is configured.
1010

11-
If you need to update the Vuetify configuration before calling `createVuetify` and registering the plugin, you can use the `vuetify:before-create` hook in your Nuxt Plugin:
11+
If you need to update the Vuetify configuration before `createVuetify` is called and the plugin is registered, you can use the `vuetify:before-create` hook in your Nuxt Plugin:
1212
::: code-group
1313

1414
```ts [plugins/vuetify.ts]
@@ -23,7 +23,7 @@ export default defineNuxtPlugin((nuxtApp) => {
2323

2424
:::
2525

26-
If you need the Vuetify instance after creating it, you can use the `vuetify:ready` hook in your Nuxt Plugin:
26+
If you need to access the Vuetify instance after it has been created, you can use the `vuetify:ready` hook in your Nuxt Plugin:
2727
::: code-group
2828

2929
```ts [plugins/vuetify.ts]
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Vuetify Blueprints
22

3-
The module supports Vuetify Blueprints, just add it to the `vuetifyOptions.blueprint` module option, but with some limitations:
4-
- `ssr` will be ignored, this flag can be only configured internally by the module via the Nuxt ssr option
5-
- `components` will be ignored, configure them using the `vuetifyOptions.components` module option
6-
- `directives` will be ignored, configure them using the `vuetifyOptions.directives` module option
7-
- `locale` will be ignored, configure it using the `vuetifyOptions.locale` module option
8-
- `date` will be ignored, configure it using the `vuetifyOptions.date` module option
9-
- `icons` will be ignored, configure it using the `vuetifyOptions.icons` module option
10-
- `aliases` only supports defining aliases with [strings](/guide/features/globals/global-components.html#aliasing-global-component), using a component type will result in error (`Cannot start nuxt: Unexpected token '.'`)
3+
The module supports Vuetify Blueprints. You can enable them by adding the `vuetifyOptions.blueprint` module option. Please note the following limitations:
4+
- The `ssr` option is ignored; this flag is managed internally by the module based on the Nuxt `ssr` option.
5+
- The `components` option is ignored; please configure components using the `vuetifyOptions.components` module option.
6+
- The `directives` option is ignored; please configure directives using the `vuetifyOptions.directives` module option.
7+
- The `locale` option is ignored; please configure it using the `vuetifyOptions.locale` module option.
8+
- The `date` option is ignored; please configure it using the `vuetifyOptions.date` module option.
9+
- The `icons` option is ignored; please configure it using the `vuetifyOptions.icons` module option.
10+
- The `aliases` option only supports defining aliases with [strings](/guide/features/globals/global-components.html#aliasing-global-component). Using a component type will result in an error (`Cannot start nuxt: Unexpected token '.'`).
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Transform Asset URLs
22

3-
The module configures the `transformAssetUrls` from [Vuetify Vite Plugin](https://github.com/vuetifyjs/vuetify-loader/tree/master/packages/vite-plugin#image-loading) to resolve relative asset URLs that are passed to Vuetify components such as `VImg` (e.g. `~/assets/img/some.png`).
3+
The module automatically configures `transformAssetUrls` from the [Vuetify Vite Plugin](https://github.com/vuetifyjs/vuetify-loader/tree/master/packages/vite-plugin#image-loading) to resolve relative asset URLs passed to Vuetify components, such as `VImg` (e.g., `~/assets/img/some.png`).
44

5-
You can also add custom entries to the `includeTransformAssetsUrls` module option, for example, to include external components, or you can disable the module option to exclude all entries.
5+
You can customize this behavior by adding entries to the `includeTransformAssetsUrls` module option (for example, to include external components) or by disabling the option to exclude all entries.
66

7-
The module will include the following normalizations for each entry in `includeTransformAssetsUrls` module option:
8-
- add kebab and pascal case entries (if missing from the original)
9-
- add kebab and camel case and bind (`:xxx`) attrs entries (if missing from original)
10-
- excluded normalizations on original attrs entries containing `:` (for example `xlink:href`)
7+
The module will include the following normalizations for each entry in the `includeTransformAssetsUrls` module option:
8+
- Adds kebab and pascal case entries (if missing from the original).
9+
- Adds kebab and camel case and bind (`:xxx`) attrs entries (if missing from original).
10+
- Excludes normalizations on original attrs entries containing `:` (for example `xlink:href`).

docs/guide/configuration/vuetify-options.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Vuetify Options
22

3-
You can register Vuetify options using a file, the file path **must** be relative to the root folder.
3+
You can register Vuetify options using a separate file. Please ensure the file path is relative to the root folder.
44

5-
You can also use it in Nuxt Layers, the module will scan for `vuetify.config` files with the following extensions: `js`, `mjs`, `cjs`, `ts`, `cts` and `mts`.
5+
Support for Nuxt Layers is also available; the module scans for `vuetify.config` files with the following extensions: `js`, `mjs`, `cjs`, `ts`, `cts`, and `mts`.
66

7-
This module will watch Vuetify configuration files in development and only configuration files outside `node_modules`.
7+
During development, the module monitors Vuetify configuration files, focusing on those outside `node_modules`.
88

99
::: warning CAVEATS
10-
Changing Vuetify configuration in development triggers a full page reload (sometimes 2-3) to invalidate virtual modules, avoiding a server restart. We aim to improve this in future versions.
10+
Modifying the Vuetify configuration during development may trigger a full page reload (sometimes 2-3 times) to invalidate virtual modules without restarting the server. Improvements to this process are planned for future versions.
1111

1212
With SSR and external configuration, the Nuxt dev server restarts due to lack of server-side HMR support in Nuxt.
1313
:::
@@ -61,15 +61,15 @@ export default {
6161

6262
:::
6363

64-
You can omit `vuetifyOptions`, you only need to add one of the following files, the module will load it for you:
64+
If you prefer, you can omit `vuetifyOptions` and add one of the following files; the module will load it automatically:
6565
- `vuetify.config.js`
6666
- `vuetify.config.cjs`
6767
- `vuetify.config.mjs`
6868
- `vuetify.config.ts`
6969
- `vuetify.config.cts`
7070
- `vuetify.config.mts`
7171

72-
If you want the module to omit loading your configuration file, add `config: false` to your configuration:
72+
To prevent the module from loading your configuration file, you can set `config: false` in your configuration:
7373
::: code-group
7474

7575
```ts [vuetify.config.ts]

docs/guide/features/date.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Date Support
22

3-
Use Vuetify components [that require date functionality](https://vuetifyjs.com/en/features/dates/) installing and configuring one of the [@date-io](https://github.com/dmtrKovalenko/date-io#projects) adapters.
3+
To use Vuetify components [that require date functionality](https://vuetifyjs.com/en/features/dates/), you can install and configure one of the [@date-io](https://github.com/dmtrKovalenko/date-io#projects) adapters.
44

5-
To use Vuetify components [that require date functionality](https://vuetifyjs.com/en/features/dates/):
6-
- install one of the [@date-io](https://github.com/dmtrKovalenko/date-io#projects) adapters (optional)
7-
- configure the date entry in your Vuetify configuration:
5+
Here are the steps to set up date functionality:
6+
- Install one of the [@date-io](https://github.com/dmtrKovalenko/date-io#projects) adapters (optional).
7+
- Configure the date entry in your Vuetify configuration:
88

99

1010
```ts
@@ -15,11 +15,11 @@ vuetifyOptions: {
1515
}
1616
```
1717

18-
If you also have `@nuxtjs/i18n` module installed, `vuetifyOptions.date.locale` and `vuetifyOptions.date.rtl` options will be automatically configured, beware, the configured `locale` entry will be ignored.
18+
If the `@nuxtjs/i18n` module is installed, the `vuetifyOptions.date.locale` and `vuetifyOptions.date.rtl` options will be automatically configured. Please note that any manually configured `locale` entry will be ignored in this case.
1919

20-
If you want to use a custom date adapter, you can configure it using `vuetifyOptions.date.adapter = 'custom'`, and then:
21-
- add a Nuxt Plugin and add the `vuetify:configuration` hook to configure your Vuetify options
22-
- you can import the `virtual:vuetify-date-configuration` module, you will have access to the configuration:
20+
If you prefer to use a custom date adapter, you can set `vuetifyOptions.date.adapter = 'custom'` and then follow these steps:
21+
- Add a Nuxt Plugin and use the `vuetify:configuration` hook to configure your Vuetify options.
22+
- Import the `virtual:vuetify-date-configuration` module to access the configuration:
2323

2424

2525
```ts

docs/guide/features/globals/composables.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Vuetify Composables
22

3-
No more Vuetify composables manual imports, auto-import is enabled by default:
3+
Manual imports of Vuetify composables are no longer required; auto-import is enabled by default for:
44
- [useDate](https://vuetifyjs.com/en/api/use-date/)
55
- [useDefaults](https://vuetifyjs.com/en/api/use-defaults/)
66
- [useDisplay](https://vuetifyjs.com/en/api/use-display/)
@@ -13,9 +13,9 @@ No more Vuetify composables manual imports, auto-import is enabled by default:
1313
- [useRules](https://vuetifyjs.com/en/features/rules/): from Vuetify `v3.8.0+` and Vuetify Nuxt Module `v0.19.0+`
1414
- [useMask](https://vuetifyjs.com/en/api/use-mask/): from Vuetify `v3.10.0+` and Vuetify Nuxt Module `v0.19.0+`
1515

16-
You can disable auto-import using `moduleOptions.importComposables: false`.
16+
You can disable auto-import by setting `moduleOptions.importComposables: false`.
1717

18-
If you are using another composables that collide with the Vuetify ones, enable `moduleOptions.prefixComposables: true` to prefix them with `V`:
18+
If you are using other composables that conflict with Vuetify's, you can enable `moduleOptions.prefixComposables: true` to prefix the Vuetify composables with `V`:
1919
- `useDate` => `useVDate`
2020
- `useDefaults` => `useVDefaults`
2121
- `useLayout` => `useVLayout`
@@ -30,7 +30,7 @@ If you are using another composables that collide with the Vuetify ones, enable
3030

3131
### useRules
3232

33-
`useRules` composable is available from Vuetify `v3.8.0+`. It is enabled by default if you are using Vuetify `v3.8.0+`.
33+
The `useRules` composable is available in Vuetify `v3.8.0+` and is enabled by default for that version.
3434

3535
You can configure it using `moduleOptions.enableRules` and `moduleOptions.rulesConfiguration`:
3636

docs/guide/features/globals/directives.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ outline: deep
44

55
# Directives
66

7-
By default, the module will not register any Vuetify directive. If you need to register some directive, use `vuetifyOptions.directives` module option, it has been declared properly to have better DX.
7+
By default, the module does not register any Vuetify directives. If you need to register specific directives, you can use the `vuetifyOptions.directives` module option, which is designed for a better developer experience.
88

9-
You can register all the directives or only the ones you need: check the [directives definition](https://github.com/vuetifyjs/nuxt-module/blob/main/src/types.ts#L138-L139).
9+
You can register all directives or only the ones you need. Please check the [directives definition](https://github.com/vuetifyjs/nuxt-module/blob/main/src/types.ts#L138-L139) for more details.
1010

1111
## Ignore directives <Badge type="tip" text="from v0.15.1" />
1212

13-
If you want to ignore some directives, you can use the `moduleOptions.ignoreDirectives` option. The module will configure the Vuetify Vite Plugin to [ignore](https://github.com/vuetifyjs/vuetify-loader/tree/master/packages/vite-plugin#ignoring-components-or-directives) the directives you specify.
13+
If you wish to ignore certain directives, you can use the `moduleOptions.ignoreDirectives` option. The module will then configure the Vuetify Vite Plugin to [ignore](https://github.com/vuetifyjs/vuetify-loader/tree/master/packages/vite-plugin#ignoring-components-or-directives) the specified directives.
1414

1515
## Examples
1616

1717
### Registering all the directives
1818

19-
Example registering all the Vuetify directives:
19+
Here is an example of registering all Vuetify directives:
2020

2121
::: code-group
2222

@@ -35,7 +35,7 @@ export default defineNuxtConfig({
3535

3636
### Registering one directive
3737

38-
Example registering a single Vuetify directive, use singular name or array notation:
38+
Here is an example of registering a single Vuetify directive using either the singular name or array notation:
3939
::: code-group
4040

4141
```ts [nuxt.config.ts]
@@ -53,7 +53,7 @@ export default defineNuxtConfig({
5353

5454
### Registering multiple directives
5555

56-
Example registering multiple Vuetify directives, use array notation:
56+
Here is an example of registering multiple Vuetify directives using array notation:
5757
::: code-group
5858

5959
```ts [nuxt.config.ts]

0 commit comments

Comments
 (0)