Skip to content

iconify-cli / generateIconPath

Function: generateIconPath() ​

generateIconPath(baseDir, templateName, prefix, icon, namingStrategy, placementStrategy): IconPathInfo

Defined in: src/lib/saving.ts:99

Generates the complete path information for an icon file based on the given parameters.

Parameters ​

baseDir ​

string

The base directory from where the generated data should be appended to

templateName ​

The used template name

"raw" | "svg" | "raw-ts" | "vue" | "php" | "jsx" | "tsx"

prefix ​

string

The collections prefix (mdi, material-icons)

icon ​

string

The name of the icon

namingStrategy ​

NamingStrategy

Defines the naming strategy for the icon file

placementStrategy ​

PlacementStrategy

Specifies where the icon should be placed

Returns ​

IconPathInfo

An object containing the generated result