Nuxt Compose Icons

Appearance

nuxt-compose-icons / module / NuxtComposeIconsOptions

Interface: NuxtComposeIconsOptions ​

Defined in: module.ts:92

Properties ​

cacheDir? ​

ts
optional cacheDir?: string;

Defined in: module.ts:182

Directory used to persist the SVG processing cache across builds. Resolved relative to the project root. Defaults to node_modules/.cache/nuxt-compose-icons. Safe to gitignore.

component? ​

ts
optional component?: IconComponentOptions;

Defined in: module.ts:109

Component generation options: naming, output directory, file format.

debug? ​

ts
optional debug?: boolean;

Defined in: module.ts:173

Show additional debug logs during setup.

Default ​

ts
false

dryRun? ​

ts
optional dryRun?: boolean;

Defined in: module.ts:157

Log component names without writing files. Useful to preview what will be generated.

Default ​

ts
false

iconSizes? ​

ts
optional iconSizes?: ComposeIconSize;

Defined in: module.ts:123

Icon sizes used to generate --size-* CSS variables and size classes. Merged on top of the defaults, so unspecified keys remain available.

defaults: { sm: '1.5rem', md: '2rem', lg: '3rem', xl: '4rem' }

includeComposables? ​

ts
optional includeComposables?: boolean;

Defined in: module.ts:145

Auto-import useComposeIcon and useComposeIconRegistry composables. Disable if you only use the generated components and don't need dynamic lookup.

Default ​

ts
true

includeOverview? ​

ts
optional includeOverview?: boolean;

Defined in: module.ts:136

Register the built-in <ComposeIconOverview /> component. Useful during development to browse all available icons.

Default ​

ts
false

pathToIcons? ​

ts
optional pathToIcons?: string;

Defined in: module.ts:102

The path to the .svg icons directory

reRunOnBuild? ​

ts
optional reRunOnBuild?: boolean;

Defined in: module.ts:165

Whether to re-run icon generation on every build. (bypassing the built-in cache)

Default ​

ts
false