# ember-cli-image-transformer

> Transform Images for your Ember Application

Latest version **7.1.1** (published 2025-07-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install ember-cli-image-transformer
pnpm add ember-cli-image-transformer
yarn add ember-cli-image-transformer
bun add ember-cli-image-transformer
```

## Health

**Score 35/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 7.1.1 |
| Published | 2025-07-03 |
| First published | 2017-11-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 18 |
| Dependencies | 7 |
| Unpacked size | 12.8 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 30 |
| Author | Jonathan Johnson |
| Maintainers | jrjohnson |
| Keywords | ember-addon, image, icon, sharp |

## Links

- npm: https://www.npmjs.com/package/ember-cli-image-transformer
- Repository: https://github.com/jrjohnson/ember-cli-image-transformer
- Homepage: https://github.com/jrjohnson/ember-cli-image-transformer#readme
- Issues: https://github.com/jrjohnson/ember-cli-image-transformer/issues
- npm.io page: https://npm.io/package/ember-cli-image-transformer

## Dependencies (7)

- [sharp](https://npm.io/package/sharp.md) ^0.34.2
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.25.2
- [broccoli-funnel](https://npm.io/package/broccoli-funnel.md) ^3.0.8
- [ember-cli-babel](https://npm.io/package/ember-cli-babel.md) ^8.2.0
- [ember-cli-htmlbars](https://npm.io/package/ember-cli-htmlbars.md) ^6.3.0
- [broccoli-merge-trees](https://npm.io/package/broccoli-merge-trees.md) ^4.2.0
- [broccoli-caching-writer](https://npm.io/package/broccoli-caching-writer.md) ^3.0.3

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [stockfish](https://npm.io/package/stockfish.md) — 27.0K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads

## Recent versions

- 7.1.1 (latest) — 2025-07-03
- 7.0.0 — 2023-08-29
- 6.0.0 — 2023-06-06
- 5.0.0 — 2021-10-25
- 4.0.3 — 2020-10-19
- 4.0.2 — 2020-06-17
- 4.0.1 — 2020-04-14
- 4.0.0 — 2020-03-11
- 3.2.0 — 2020-01-04
- 3.1.0 — 2019-10-09
- 3.0.1 — 2019-06-19
- 3.0.0 — 2019-06-06
- 2.2.0 — 2019-02-08
- 2.1.0 — 2018-09-28
- 2.0.0 — 2018-06-25
- … 5 more at https://npm.io/package/ember-cli-image-transformer/versions

## README

# ember-cli-image-transformer

[![Build Status](https://travis-ci.org/jrjohnson/ember-cli-image-transformer.svg?branch=master)](https://travis-ci.org/jrjohnson/ember-cli-image-transformer)
[![Ember Observer Score](https://emberobserver.com/badges/ember-cli-image-transformer.svg)](https://emberobserver.com/addons/ember-cli-image-transformer)

## Transform Images for your Ember Application from One Source Image

I hate having to create a bunch of identical images for use as icons and favicon images for my application, so I created this addon to take a single source image and transform it into many images of differing sizes, types, and backgrounds.

It is built using EmberJS and takes advantage of the awesome [Sharp](https://github.com/lovell/sharp) library to do the heavy lifting.

## Compatibility

- Ember.js v4.12 or above
- Ember CLI v4.12 or above
- Node.js v18 or above

## Installation

```bash
ember install ember-cli-image-transformer
```

## Usage

Create an `ember-cli-image-transformer` section in your `ember-cli-build.js` file with
an `images` array. Each element in the array represents a different set of images to
be generated.

```js
module.exports = function(defaults) {
  var app = new EmberApp(defaults, {
    'ember-cli-image-transformer': {
      images: [
        {
          inputFilename: 'public/square.svg',
          outputFileName: 'icon-square',
          convertTo: 'png',
          sizes: [16, 32, 45, 900],
        },
        {
          inputFilename: 'public/circle.svg',
          outputFileName: 'transparent-circle',
          convertTo: 'png',
          background: {r: 255, g: 255, b: 255, alpha: 0},
          sizes: [100],
        }
      ]
    }
  });
```

All generated images will be placed into the `public/assets` path of your application.

### Usage with custom quality

The Sharp library uses default quality values depending on the output format. If the file type [supports it](https://sharp.pixelplumbing.com/api-output/#toformat), you may pass an optional `quality: [number]` in your image object array:

```js
images: [
  {
    inputFilename: 'public/trapezoid.svg',
    outputFileName: 'icon-trapezoid',
    convertTo: 'png',
    sizes: [32, 48, 192],
    quality: 50,
  }
]
```

### Usage in a template

```handlebars
<!-- application.hbs -->
<img src='assets/transparent-circle100.png'>
```

### Image Options

| Key | Required | Default Value | Example | Description |
|-----|----------|---------------|---------|-------------|
|`inputFileName`| :heavy_check_mark: | none | `public/circle.svg` | Where (relative to the application root) to find the input image |
|`outputFileName`| :heavy_check_mark: | none |  `transparent-circle` | This is combined with the `convertTo` and `size` to create the output file eg `transparent-circle92.png` |
|`convertTo`| :heavy_check_mark: | none |  `png` | The output file type |
|`sizes`| :heavy_check_mark: | none |  `[92, 150]` | An array of image sizes to produce |
|`destination`| | `assets/icons` |  `images/wherever/you/want` | The destination directory for the output images relative to `/public` |
|`background`|  | none |  `{r: 255, g: 255, b: 255, alpha: 0}` | Add a background color to the image. |
|`quality`|  | varies by format |  `25` | The quality (out of 100) of the image processing. |

## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.

## License

This project is licensed under the [MIT License](LICENSE.md).

---
_Source: https://npm.io/package/ember-cli-image-transformer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
