Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ember-cli-favicon

davewasmer13.2kMIT3.0.0

Automatically build and include all the various platform / device favicon formats from a single source public/favicon.png.

ember-addon, favicon

readme

ember-cli-favicon

CI Dependency Status

Take a single favicon source file at public/favicon.png, and convert to the various formats and sizes required for popular devices and platforms. Also injects the appropriate HTML into your index.html file during the build process.

Compatibility

  • Ember.js v3.20 or above
  • Ember CLI v3.20 or above
  • Node.js v12 or above

Installation

ember install ember-cli-favicon

Usage

Just save an image to public/favicon.png (try to make sure it's at least 256x256). Additional configuration options are supplied in your ember-cli-build.js file with following defaults:

// ember-cli-build.js
var app = new EmberApp({
  'ember-cli-favicon': {
    enabled: env != 'test', // By default favicons are NOT generated in TEST env to speedup builds

    onSuccess() {}, // You can call your callback when favicons are generated successfully

    iconPath: 'favicon.png', // icon path related to `public` folder

    // See the [favicons](https://github.com/itgalaxy/favicons) module for details on the available configuration options.
    faviconsConfig: {
      // these options are passed directly to the favicons module
      path: projectConfig.rootUrl,
      appName: package.name,
      appShortName: package.name,
      appDescription: package.description,
      developerName: package.author,
      version: package.version,
      icons: {
        favicons: true,
        android: isProductionEnv,
        appleIcon: isProductionEnv,
        appleStartup: isProductionEnv,
        coast: isProductionEnv,
        firefox: isProductionEnv,
        windows: isProductionEnv,
        yandex: isProductionEnv
      }
    }
  }
});

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.

changelog

Change Log

v2.2.0 (2019-06-10)

Full Changelog

Implemented enhancements:

Closed issues:

  • Can we do this without coffeescript? #77

Merged pull requests:

v2.1.1 (2019-06-05)

Full Changelog

Fixed bugs:

Closed issues:

  • Build Error #81
  • Fingerprints not added to the manifests #78

v2.1.0 (2019-05-13)

Full Changelog

v2.0.0 (2018-11-19)

Full Changelog

Merged pull requests:

v1.1.1 (2018-11-17)

Full Changelog

v1.1.0 (2018-11-17)

Full Changelog

Closed issues:

  • Plans to remove PhantomJS dependency #72
  • New release? #71
  • Handle fingerprinting issue (or document) #70
  • Build error with ember build #66
  • Causes build error with ember-cli-deploy #62

Merged pull requests:

v1.0.0 (2018-06-04)

Full Changelog

Closed issues:

  • Configuration for icons is not honoured #68
  • Relative URLs should be generated #17
  • Error with app.opitons.favicon[s] #15
  • Performance #10

Merged pull requests:

v1.0.0-beta.4 (2016-06-23)

Full Changelog

v1.0.0-beta.3 (2016-06-22)

Full Changelog

Closed issues:

  • Disabling platforms #7
  • HTML doesn't generate when cached #6
  • Excluding from fingerprint #5
  • Overriding default options #4
  • Writes [object Object] before index.html </head> #2

Merged pull requests:

v1.0.0-beta.2 (2016-04-14)

Full Changelog

Closed issues:

  • Plugin abandoned #8

Merged pull requests:

v1.0.0-beta.1 (2016-04-14)

Full Changelog

v0.0.4 (2015-11-02)

Full Changelog

v0.0.3 (2015-06-12)

Full Changelog

Merged pull requests:

  • Use callback instead of htmlCallback #1 (cesarizu)

v0.0.2 (2015-05-23)

* This Change Log was automatically generated by github_changelog_generator