3.0.0 • Published 10 months ago

@angular-extensions/svg-icons-builder v3.0.0

Weekly downloads
208
License
MIT
Repository
github
Last release
10 months ago

svg-icons-builder

All Contributors

The svg-icons-builder is a Angular builder for the svg-to-ts project. It can be used to convert SVG icons inside an Angular library or SPA to an object, to constants or even to individual TypeScript or JavaScript files. Find out more on the official svg-to-ts docs.

Usage

Installation

NPM: npm install @angular-extensions/svg-icons-builder

Angular CLI: ng add @angular-extensions/svg-icons-builder

Configure the builder

To use the builder you need to add a new entry to your architect object inside your angular.json.

A valid svg-to-ts configuration. ⚠️ the options depend on the conversionType and may therefore vary. Means, a configuration for the convesionType: "files" will look different than configuration for the conversionType: "constants". Each conversionType has it's own builder.

In our example we call it generate-icons. You then need to specify the following properties:

conversionType: constants

"generate-icons": {
  "builder": "@angular-extensions/svg-icons-builder:svg-icons-constants-builder",
  "options": {
      "conversionType": "constants",
      "fileName": "myIcons",
      "generateType": false,
      "generateTypeObject": false,
      "generateCompleteIconSet": true,
      "srcFiles": ["./src/icons/*.svg"],
      "outputDirectory": "./dist/icons",
      "interfaceName": "DinosaurIcon",
      "typeName": "dinosaurIcon",
      "prefix": "dinosaurIcon",
      "svgoConfig": {
        "plugins": ["cleanupAttrs"]
      }
  }
}

conversionType: files

  "generate-icons": {
    "builder": "@angular-extensions/svg-icons-builder:svg-icons-files-builder",
    "options": {
      "conversionType": "files",
      "srcFiles": ["./projects/dinosaur-icons/icons/**/*.svg"],
      "outputDirectory": "./dist/dinosaur-icons/icons",
      "interfaceName": "DinosaurIcon",
      "generateType": false,
      "generateTypeObject": false,
      "generateCompleteIconSet": false,
      "exportCompleteIconSet": false,
      "fileName": "dinosaur-icons",
      "iconsFolderName": "dinosaur-icons",
      "objectName": "dinosaur-icons",
      "typeName": "dinosaurIcon",
      "prefix": "dinosaurIcon",
      "modelFileName": "dinosaur-icons",
      "barrelFileName": "index",
      "svgoConfig": {
        "plugins": ["cleanupAttrs"]
      },
      "compileSources": true
    }
  }

conversionType: object

  "generate-icons": {
    "builder": "@angular-extensions/svg-icons-builder:svg-icons-object-builder",
    "options": {
      "conversionType": "object",
      "srcFiles": ["./projects/dinosaur-icons/icons/**/*.svg"],
      "outputDirectory": "./dist/dinosaur-icons/icons",
      "fileName": "dinosaur-icons",
      "objectName": "dinosaur-icons",
      "svgoConfig": {
        "plugins": ["cleanupAttrs"]
      },
      "compileSources": true
    }
  }

Run the builder

In order to run the builder you have to add a new npm script to your package.json. Replace name-of-your-app with the name of your application 😉.

"genrate-icons": "ng run name-of-your-app:generate-icons"

Core Team ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!