This Drupal module contains a framework for defining and outputting SVG icons.

Warning: while this is generally production-ready, it's not guaranteed to maintain a stable API and may occasionally contain bugs, being a work-in-progress. Stable releases may be provided at a later date.

---

Requirements

• Drupal 9.5 or Drupal 10 (Drupal 8 is end-of-life)

• Composer

Drupal dependencies

Before attempting to install this, you must add the Composer repositories as described in the installation instructions for these dependencies:

• The ambientimpact_core module.

Front-end dependencies

To build front-end assets for this project, Node.js and Yarn are required.

---

Installation

Composer

Set up

Ensure that you have your Drupal installation set up with the correct Composer installer types such as those provided by the drupal/recommended-project template. If you're starting from scratch, simply requiring that template and following the Drupal.org Composer documentation should get you up and running.

Repository

In your root composer.json, add the following to the "repositories" section:

"drupal/ambientimpact_icon": {
  "type": "vcs",
  "url": "https://github.com/Ambient-Impact/drupal-ambientimpact-icon.git"
}

Installing

Once you've completed all of the above, run composer require "drupal/ambientimpact_icon:^1.0@dev" in the root of your project to have Composer install this and its required dependencies for you.

Front-end assets

To build front-end assets for this project, you'll need to install Node.js and Yarn.

This package makes use of Yarn Workspaces and references other local workspace dependencies. In the package.json in the root of your Drupal project, you'll need to add the following:

"workspaces": [
  "<web directory>/modules/custom/*"
],

where <web directory> is your public Drupal directory name, web by default. Once those are defined, add the following to the "dependencies" section of your top-level package.json:

"drupal-ambientimpact-icon": "workspace:^1"

Then run yarn install and let Yarn do the rest.

Optional: install yarn.BUILD

While not required, yarn.BUILD is recommended to make building all of the front-end assets even easier.

---

Building front-end assets

This uses Webpack and Symfony Webpack Encore to automate most of the build process. These will have been installed for you if you followed the Yarn installation instructions above.

If you have yarn.BUILD installed, you can run:

yarn build

from the root of your Drupal site. If you want to build just this package, run:

yarn workspace drupal-ambientimpact-icon run build

---

Major breaking changes

The following major version bumps indicate breaking changes:

• 1.x:

  • Has been git subtree split from Ambient-Impact/drupal-modules into a standalone package; version has been reset to 1.x.

  • Requires Drupal 9.5 or Drupal 10.

  • Increases minimum version of Hook Event Dispatcher to 3.1, removes deprecated code, and adds support for 4.0 which supports Drupal 10.