chore(module): improve tsdoc

This commit is contained in:
Benjamin Canac
2024-10-08 11:58:23 +02:00
parent 1fc21af918
commit 7c4ffa56ec

View File

@@ -9,32 +9,41 @@ export type * from './runtime/types'
export interface ModuleOptions { export interface ModuleOptions {
/** /**
* Prefix for components * Prefix for components
* @defaultValue U * @defaultValue `U`
* @see https://ui3.nuxt.dev/getting-started/installation#prefix
*/ */
prefix?: string prefix?: string
/** /**
* Enable or disable `@nuxt/fonts` module * Enable or disable `@nuxt/fonts` module
* @defaultValue true * @defaultValue `true`
* @see https://ui3.nuxt.dev/getting-started/installation#fonts
*/ */
fonts?: boolean fonts?: boolean
/** /**
* Enable or disable `@nuxtjs/color-mode` module * Enable or disable `@nuxtjs/color-mode` module
* @defaultValue true * @defaultValue `true`
* @see https://ui3.nuxt.dev/getting-started/installation#colormode
*/ */
colorMode?: boolean colorMode?: boolean
/**
* Customize how the theme is generated
* @see https://ui3.nuxt.dev/getting-started/theme
*/
theme?: { theme?: {
/** /**
* Colors to generate classes for (defaults to TailwindCSS colors) * Define the color aliases available for components
* @defaultValue ['primary', 'secondary', 'success', 'info', 'warning', 'error'] * @defaultValue `['primary', 'secondary', 'success', 'info', 'warning', 'error']`
* @see https://ui3.nuxt.dev/getting-started/installation#themecolors
*/ */
colors?: string[] colors?: string[]
/** /**
* Enable or disable transitions on components * Enable or disable transitions on components
* @defaultValue true * @defaultValue `true`
* @see https://ui3.nuxt.dev/getting-started/installation#themetransitions
*/ */
transitions?: boolean transitions?: boolean
} }
@@ -46,7 +55,8 @@ export default defineNuxtModule<ModuleOptions>({
configKey: 'ui', configKey: 'ui',
compatibility: { compatibility: {
nuxt: '>=3.13.1' nuxt: '>=3.13.1'
} },
docs: 'https://ui3.nuxt.dev/getting-started/installation'
}, },
defaults: { defaults: {
prefix: 'U', prefix: 'U',