@nhtio/vue-editors/icons

Functionality for retreiving and icons provided by the Vue Editors library.

Classes

Class	Description
NVEFileIcon	Vue component for displaying a file icon based on its filename.
NVEFolderIcon	Vue component for displaying a folder icon based on its name.
NVEIcon	Vue component for displaying an icon based on its name and kind.
NVEIconElement	Vue component for displaying an icon.

Type Aliases

Type Alias	Description
NVEFileIconProps	Properties for the NVEFileIcon component.
NVEFolderIconProps	Properties for the NVEFolderIcon component.
NVEIconElementProps	Properties for the NVEIconElement component.
NVEIconName	The names of the known icons available in the NVE icon set.
NVEIconProps	Properties for the NVEIcon component.

Functions

Function	Description
getIcon	Retrieves the icon URL for a given name and kind.
getIconForDefaultFile	Returns the icon URL for a default file.
getIconForDefaultFolder	Returns the icon URL for a default (non-root) folder.
getIconForFile	Returns the icon URL for a file, based on its name or extension. Falls back to the default file icon if no match is found.
getIconForFolder	Returns the icon URL for a specific folder name, or the default if not found.
getIconForRootFolder	Returns the icon URL for the root folder.
setIcon	Sets a custom icon URL for a given icon name.