GridCraft.Icon | GridCraft

GridCraft.Icon

Icons etc

API Overview #

Deprecateds - API features which will be removed in an upcoming release
- macFile
Functions - API calls offered directly by the extension

API Documentation #

Deprecateds #

macFile #

Signature	`GridCraft.Icon.macFile(filePath) -> string or nil`
Type	Deprecated
Description	Use fromMacIcon() instead.

Functions #

phosphor #

Signature	`GridCraft.Icon.phosphor(name, [weight]) -> string or nil`
Type	Function
Description	Create an icon from a Phosphor icon name and weight
Parameters	name - The name of the Phosphor icon (e.g., “app-window”) weight - The weight of the icon (e.g., “regular”, “bold”, “duotone”). Defaults to “regular”.

fromMacIcon #

Signature	`GridCraft.Icon.fromMacIcon(filePath) -> string or nil`
Type	Function
Description	Create an icon from the icon of a macOS file (including folders, applications, etc)
Parameters	filePath - The path to the file or application for which to get the icon

fileContents #

Signature	`GridCraft.Icon.fileContents(filePath) -> string or nil`
Type	Function
Description	Create an icon from the contents of a file
Parameters	filePath - The path to the file to read fileType - The MIME type of the file, like “image/png” or “image/svg+xml”
Returns	string containing a data URI with base64-encoded data of the file

empty #

Signature	`GridCraft.Icon.empty() -> string`
Type	Function
Description	Create an empty icon, which is a transparent PNG image
Parameters	None
Returns	string containing an img tag with the transparent PNG data