Options
All
  • Public
  • Public/Protected
  • All
Menu

Icon URL Format

There are three types of icon url formats can be used:

  • Local Path
    • Relative path - relative local path to package.json. e.g. ./icon.png
    • Absolute path - absolute local path. e.g. C:\\Documents\\icon.png
  • Remote Path - General HTTP URL.
    • e.g. https://github.com/icon.png
  • Font Awesome Classname.

Example

function search(query, res) {
    res.add({
        title: ...,
        desc:  ...,
        icon:  '#fa fa-youtube'
    });
}

Generated using TypeDoc