Nuxt Compose Icons

Appearance

nuxt-compose-icons / runtime/composables/use-compose-icons-registry / useComposeIconRegistry

Function: useComposeIconRegistry() ​

ts
function useComposeIconRegistry(): object;

Defined in: runtime/composables/use-compose-icons-registry.ts:7

Returns ​

filteredIcons ​

ts
filteredIcons: (query) => ComputedRef<IconRegistryEntry[]>;

Parameters ​

query ​

MaybeRefOrGetter<string>

Returns ​

ComputedRef<IconRegistryEntry[]>

getIconsByName ​

ts
getIconsByName: (name) => IconRegistryEntry[];

Get an Icon Component by its name

Parameters ​

name ​

string

Returns ​

IconRegistryEntry[]

icons ​

ts
icons: IconRegistryEntry[];

searchIcons ​

ts
searchIcons: (query) => IconRegistryEntry[];

Parameters ​

query ​

string

Returns ​

IconRegistryEntry[]