Skip to content

An optional svg icon set for use with Bindable

License

Notifications You must be signed in to change notification settings

bindable-ui/bindable-icons

Repository files navigation

Bindable Icons

Bindable Icons is an optional icon set that can be used with Bindable. Both Bindable and Bindable-Icons are built as an Aurelia plugin and work with Aurelia JS. The c-icon component in Bindable places svg icons on the page by pointing to a svg sprite map that this plugin creates. If you choose not to use Bindable Icons you would need to include your own svg sprite map in your app. You can get more info about svg maps here.

Install

npm i @bindable-ui/bindable-icons

Usage

You will need to register this plugin in your app. Place this in src/main.ts

aurelia.use
  ...
  .plugin(PLATFORM.moduleName('@bindable-ui/bindable-icons'))

Place this where you would like the svg sprite map placed in your code.

<bindable-icons></bindable-icons>