feat(docs): add description for kit'sinstallModule

This commit is contained in:
Andrey Yolkin 2023-07-28 16:00:44 +03:00
parent 9741f267be
commit 4daa626e85

View File

@ -14,7 +14,29 @@ description: Nuxt Kit provides composable utilities to help interacting with Nux
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/module)
- `installModule(module, inlineOptions)`
#### `installModule(module, inlineOptions)`
Install specified Nuxt module programmatically. This is helpful when your module depends on other modules. You can pass the module options as an object to `inlineOptions` and they will be passed to the module's `setup` function.
```ts
import { defineNuxtModule, installModule } from '@nuxt/kit'
export default defineNuxtModule<ModuleOptions>({
async setup (options, nuxt) {
// will install @nuxtjs/fontaine with Roboto font and Impact fallback
await installModule('@nuxtjs/fontaine', {
// module configuration
fonts: [
{
family: 'Roboto',
fallbacks: ['Impact'],
fallbackName: 'fallback-a',
}
]
})
}
})
```
### Programmatic Usage