ember-heroicons

ember-heroicons

This addon provides access to the heroicons SVG icons within your Ember applications.

Installation

ember install ember-heroicons

Demo

Demo

Usage

The basic usage:

<HeroIcon @icon="check-circle" />

The HeroIcon component supports the following arguments:

• @icon - the name of the icon to render
• @type - one of outline, solid or mini

Custom configuration

By default, all icons for all types will be available within your application. Additionally, the default icon type, if not specified, will be outline.

If you know you will only be using a subset of icons, then you can greatly reduce the size of your app by customizing the configuration.

You can customize defaults and available icons by adding a heroicons configuration object to your application's environment.js. As an example:

module.exports = function (environment) {
    let ENV = {
        // Add options here
        heroicons: {
            // default type to use if not specified to the HeroIcon component
            defaultType: "mini",
            // omit matching icons (array of string or RegExp)
            omit: [/chevron/, "camera"],
            // include only certain matching icons (array of string or RegExp)
            include: [/.*/],
            // include only certain types (outline, solid, mini)
            types: ["outline"],
        },
    };
    // ...
    return ENV;
};

Compatibility

• Ember.js v3.24 or above
• Ember CLI v3.24 or above
• Node.js v14 or above

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.

Changelog

0.1.1

• Fixed dependencies to include required dependencies for apps/consumers