Nuxt Compose Icons

Appearance

nuxt-compose-icons / module / IconComponentOptions

Interface: IconComponentOptions ​

Defined in: module.ts:31

Properties ​

case? ​

ts
optional case?: "pascal" | "kebab";

Defined in: module.ts:56

Naming convention for the generated component.

Default ​

ts
'pascal'

destDir? ​

ts
optional destDir?: string;

Defined in: module.ts:64

Directory where generated components are written. Defaults to .nuxt/compose-icons.

fileFormat? ​

ts
optional fileFormat?: "vue" | "ts";

Defined in: module.ts:73

Format of the generated component file, either as a Vue SFC (.vue) or as a TypeScript file (.ts)

Default ​

ts
'ts'

hasIndexFile? ​

ts
optional hasIndexFile?: boolean;

Defined in: module.ts:81

Write an index.ts barrel file in destDir.

Default ​

ts
false

iconClasses? ​

ts
optional iconClasses?: string | string[];

Defined in: module.ts:89

Extra CSS classes applied to every generated icon component.

Default ​

ts
[]

prefix? ​

ts
optional prefix?: string;

Defined in: module.ts:39

Prefix prepended to the generated component name. e.g. 'My' → <MyArrowUpIcon />

Default ​

ts
undefined

suffix? ​

ts
optional suffix?: string;

Defined in: module.ts:48

Suffix appended to the generated component name. e.g. 'Icon' → <ArrowUpIcon />

Default ​

ts
'Icon'