@futureforms/ngx-butter-icons

ngx-butter-icons

ngx-butter-icons is a set of icons for easy scalable vector graphics on websites and in web application created with the Angular framework, created and maintained by Future Forms.

Demo

Visit our demo page and get an overview of over 250+ icons in two different sizes icons.futureforms.studio

Installation

You can install it through npm:

npm install @futureforms/ngx-butter-icons

In angular.json you have to add the following asset config to include the icons in your build:

{
  "glob": "**/*",
  "input": "./node_modules/@futureforms/ngx-butter-icons/icons/",
  "output": "./ngx-butter-icons/"
}

The angular.json structure would then look like this:

"projects": {
  "<YOUR_PROJECT>": {
    "architect": {
      "build": {
        "options": {
          "assets": [
            {
              "glob": "**/*",
              "input": "./node_modules/@futureforms/ngx-butter-icons/icons/",
              "output": "./ngx-butter-icons/"
            }
          ]
        }
      }
    }
  }
}

As final step you will also need to import NgxButterIconsModule in your module:

import { NgxButterIconsModule } from '@futureforms/<TITLE>';

@NgModule({
  imports: [NgxButterIconsModule]
})
class AppModule {}

Basic Usage

Use the NgxButterIconComponent in your templates like this:

<ngx-butter-icon [icon]="briefcase--outlined-a" [size]="24"></ngx-butter-icon>