marmotte

Appearance

marmotte / vite/ui

vite/ui ​

Interfaces ​

UIAppPluginOptions ​

Defined in: src/vite/ui.ts:96

Extracts the resolved options type (ctx.options) from a VitePluginContext instance or class.

Extends ​

Properties ​

root ​

root: string

Defined in: src/vite/lib/context.ts:28

Inherited from ​

UICommonPluginOptions.root

sourceDir? ​

optional sourceDir?: string = "./src"

Defined in: src/vite/lib/context.ts:188

Inherited from ​

UICommonPluginOptions.sourceDir

vue? ​

optional vue?: WithNoDefaults<Options>

Defined in: src/vite/ui.ts:19

Inherited from ​

UICommonPluginOptions.vue

vueComponents? ​

optional vueComponents?: WithNoDefaults<Options>

Defined in: src/vite/ui.ts:20

Inherited from ​

UICommonPluginOptions.vueComponents

vueRouter? ​

optional vueRouter?: false | WithNoDefaults<Options>

Defined in: src/vite/ui.ts:97

vuetify? ​

optional vuetify?: false | Options

Defined in: src/vite/ui.ts:22

Options for vite-plugin-vuetify or false to deactivate

Inherited from ​

UIAppPluginOptions.vuetify

UICommonPluginOptions ​

Defined in: src/vite/ui.ts:18

Extracts the resolved options type (ctx.options) from a VitePluginContext instance or class.

Extends ​

Extended by ​

Properties ​

root ​

root: string

Defined in: src/vite/lib/context.ts:28

Inherited from ​

contextOptions.root

sourceDir? ​

optional sourceDir?: string = "./src"

Defined in: src/vite/lib/context.ts:188

Inherited from ​

contextOptions.sourceDir

vue? ​

optional vue?: WithNoDefaults<Options>

Defined in: src/vite/ui.ts:19

vueComponents? ​

optional vueComponents?: WithNoDefaults<Options>

Defined in: src/vite/ui.ts:20

vuetify? ​

optional vuetify?: false | Options

Defined in: src/vite/ui.ts:22

Options for vite-plugin-vuetify or false to deactivate

UILibPluginOptions ​

Defined in: src/vite/ui.ts:60

Extracts the resolved options type (ctx.options) from a VitePluginContext instance or class.

Extends ​

Properties ​

docs? ​

optional docs?: false | Options

Defined in: src/vite/lib.ts:75

Options for the Docs plugin, use false to disable

Inherited from ​

LibPluginOptions.docs

dts? ​

optional dts?: WithNoDefaults<PluginOptions>

Defined in: src/vite/lib.ts:71

Options for the vite-plugin-dts (will be merged with defaults)

Inherited from ​

LibPluginOptions.dts

entries? ​

optional entries?: PathFilter

Defined in: src/vite/lib.ts:20

A filter to automatically add files from UserVitePluginOptions.sourceDir to entries.

If not defined and no entry is manually added by the user in its vite config, <sourceDir>/index.ts will be used

Example ​
ts
/(?<!\.d)(?<!\.test)(?<!\.test-d)\.ts$/
Inherited from ​

LibPluginOptions.entries

externals? ​

optional externals?: ExternalsOptions

Defined in: src/vite/lib.ts:73

Options for the rollup-plugin-node-externals

Inherited from ​

LibPluginOptions.externals

root ​

root: string

Defined in: src/vite/lib/context.ts:28

Inherited from ​

UICommonPluginOptions.root

sourceDir? ​

optional sourceDir?: string = "./src"

Defined in: src/vite/lib/context.ts:188

Inherited from ​

UICommonPluginOptions.sourceDir

typedoc? ​

optional typedoc?: false | Options

Defined in: src/vite/lib.ts:77

Options for the TypeDoc plugin, use false to disable (disabled by default if docs: false)

Inherited from ​

LibPluginOptions.typedoc

vue? ​

optional vue?: Options

Defined in: src/vite/ui.ts:61

Overrides ​

UICommonPluginOptions.vue

vueComponents? ​

optional vueComponents?: Options

Defined in: src/vite/ui.ts:62

Overrides ​

UICommonPluginOptions.vueComponents

vuetify? ​

optional vuetify?: false | Options

Defined in: src/vite/ui.ts:64

Options for vite-plugin-vuetify or false to deactivate

Overrides ​

UIAppPluginOptions.vuetify

Functions ​

UIApp() ​

UIApp(options): PluginOption[]

Defined in: src/vite/ui.ts:105

Configures Vite to build a Vue application. Combines UICommon (Vue + Vuetify) with vue-router/vite for file-based routing. Pass vueRouter: false to disable the router plugin.

Parameters ​

options ​

UIAppPluginOptions

Returns ​

PluginOption[]

UICommon() ​

UICommon(options): (Plugin<any> | Plugin<any>[])[] & object

Defined in: src/vite/ui.ts:33

Shared base plugin setup used by both UILib and UIApp. Includes BaseBundle, @vitejs/plugin-vue, unplugin-vue-components, and optionally vite-plugin-vuetify (enabled by default).

Returns the plugin array augmented with a ctx property so callers can reuse the resolved DefaultVitePluginContext (e.g. for additional path resolution).

Parameters ​

options ​

UICommonPluginOptions

Returns ​

(Plugin<any> | Plugin<any>[])[] & object

UILib() ​

UILib(options): Plugin<any>[]

Defined in: src/vite/ui.ts:71

Configures vite to build a vue UI library uses unplugin-vue-components and vuetify by default

Parameters ​

options ​

UILibPluginOptions

Returns ​

Plugin<any>[]