Vixt

vixt / core / VixtOptions

VixtOptions ​

This is a global declared interface for module @vixt/core, it includes some properties that declared in VueVixtOptions, ReactVixtOptions, etc., see VixtConfig to view the common options.

Extends ​

Indexable ​

[key: string]: any

custom options

Properties ​

_cli? ​

optional _cli?: boolean

Internal

Whether your app is running in with vixt-cli.

Inherited from ​

VixtConfig._cli

_prepare? ​

optional _prepare?: boolean

Internal

Inherited from ​

VixtConfig._prepare

alias? ​

optional alias?: AliasOptions

You can improve your DX by defining additional aliases to access custom directories within your JavaScript and CSS.

Default ​

json
{
  "@": "/<rootDir>/<srcDir>",
  "~": "/<rootDir>/<srcDir>",
  "~~": "/<rootDir>",
  "@@": "/<rootDir>",
  "#": "/<rootDir>/<buildDir>"
}

Inherited from ​

VixtConfig.alias

app? ​

optional app?: AppOptions

Vixt App configuration.

Inherited from ​

VixtConfig.app

appConfig? ​

optional appConfig?: Record<string, any>

Additional app configuration.

Inherited from ​

VixtConfig.appConfig

build? ​

optional build?: BuildOptions

Shared build configuration.

Inherited from ​

VixtConfig.build

buildDir? ​

optional buildDir?: string

Define the directory where your built files will be placed.

Default ​

ts
'<rootDir>/.vixt'

Inherited from ​

VixtConfig.buildDir

buildLayersDir? ​

optional buildLayersDir?: string

Default ​

ts
'<buildDir>/layers'

Inherited from ​

VixtConfig.buildLayersDir

buildTypesDir? ​

optional buildTypesDir?: string

Default ​

ts
'<buildDir>/types'

Inherited from ​

VixtConfig.buildTypesDir

components? ​

optional components?: Options

https://github.com/antfu/unplugin-vue-components

Inherited from ​

VitepressVixtOptions.components

copyLayers? ​

optional copyLayers?: boolean

Experimental

Whether to copy layers from node_modules to .vixt/layers

Default ​

ts
true
@experimental

Inherited from ​

VixtConfig.copyLayers

debug? ​

optional debug?: boolean

Set to true to enable debug mode.

Default ​

ts
false

Inherited from ​

VixtConfig.debug

dev? ​

optional dev?: boolean

Whether your app is running in development mode.

Default ​

ts
false

Inherited from ​

VixtConfig.dev

devServer? ​

optional devServer?: DevServerOptions

Set CORS options for the dev server, the port, host, cors options will be passed to vite.server

Inherited from ​

VixtConfig.devServer

devtools? ​

optional devtools?: VitePluginVueDevToolsOptions & object

https://github.com/webfansplz/vite-plugin-vue-devtools

Type Declaration ​

enabled? ​

optional enabled?: boolean

Inherited from ​

VitepressVixtOptions.devtools

extends? ​

optional extends?: string[]

Extend project from multiple local or remote sources.

Inherited from ​

VixtConfig.extends

imports? ​

optional imports?: ImportsOptions

Configure how Vixt auto-imports composables into your application.

Inherited from ​

VixtConfig.imports

layouts? ​

optional layouts?: Partial<Options>

https://github.com/JohnCampionJr/vite-plugin-vue-layouts

Inherited from ​

ReactVixtOptions.layouts

meta? ​

optional meta?: VixtConfigLayerMeta

Custom meta for layer.

Inherited from ​

VixtConfig.meta

modules? ​

optional modules?: VixtModule<ModuleOptions>[]

Modules are Vixt extensions which can extend its core functionality and add endless integrations.

Inherited from ​

VixtConfig.modules

modulesDir? ​

optional modulesDir?: string

Define the directory of your Vixt modules.

Default ​

ts
'<srcDir>/modules'

Inherited from ​

VixtConfig.modulesDir

nitro? ​

optional nitro?: NitroOptions

Configuration for Nitro.

Inherited from ​

VixtConfig.nitro

pages? ​

optional pages?: Partial<Options>

https://github.com/hannoeru/vite-plugin-pages

Inherited from ​

ReactVixtOptions.pages

plugins? ​

optional plugins?: string[]

An array of vixt app plugins.

Inherited from ​

VixtConfig.plugins

pluginsDir? ​

optional pluginsDir?: string

Define the directory of your Vixt plugins.

Default ​

ts
'<srcDir>/plugins'

Inherited from ​

VixtConfig.pluginsDir

react? ​

optional react?: Options

Inherited from ​

ReactVixtOptions.react

rootDir? ​

optional rootDir?: string

Define the root directory of your application.

Default ​

ts
process.cwd()

Inherited from ​

VixtConfig.rootDir

router? ​

optional router?: Options

https://router.vuejs.org/file-based-routing/

Inherited from ​

VueVixtOptions.router

srcDir? ​

optional srcDir?: string

Define the source directory of your application.

Default ​

ts
'<rootDir>/src'

Inherited from ​

VixtConfig.srcDir

ssr? ​

optional ssr?: boolean

Whether to enable rendering of HTML.

Inherited from ​

VixtConfig.ssr

test? ​

optional test?: boolean

Whether your app is being unit tested.

Default ​

ts
false

Inherited from ​

VixtConfig.test

typescript? ​

optional typescript?: TypescriptOptions

Configuration for TypeScript integration.

Inherited from ​

VixtConfig.typescript

uni? ​

optional uni?: VitePluginUniOptions

Inherited from ​

UniVixtOptions.uni

uniComponents? ​

optional uniComponents?: Options

https://github.com/uni-helper/vite-plugin-uni-components

Inherited from ​

UniVixtOptions.uniComponents

uniLayouts? ​

optional uniLayouts?: UniLayoutsOptions

https://github.com/uni-helper/vite-plugin-uni-layouts

Inherited from ​

UniVixtOptions.uniLayouts

uniModules? ​

optional uniModules?: UniModulesOptions

Options for extends uni-modules

Inherited from ​

UniVixtOptions.uniModules

uniPages? ​

optional uniPages?: Partial<Options>

https://github.com/uni-helper/vite-plugin-uni-pages

Inherited from ​

UniVixtOptions.uniPages

vite? ​

optional vite?: Omit<UserConfig, "plugins">

Configuration that will be passed directly to Vite.

Inherited from ​

VixtConfig.vite

vue? ​

optional vue?: Options

https://github.com/vitejs/vite-plugin-vue/tree/main/packages/plugin-vue

Inherited from ​

VueVixtOptions.vue

vueJsx? ​

optional vueJsx?: Options

https://github.com/vitejs/vite-plugin-vue/tree/main/packages/plugin-vue-jsx

Inherited from ​

VueVixtOptions.vueJsx

workspaceDir? ​

optional workspaceDir?: string

Define the monorepo workspace directory of your application.

Inherited from ​

VixtConfig.workspaceDir