@heroku/ember-malibu-icon

Ember Malibu 🌴 Icon

This Ember addon injects the Malibu svg sprite into your Ember application and provides a helper to insert icons into your templates. You can explore how this helper works in this addon's demo app.

Note that it will be helpful if you also use Purple 3 for styling

Installation

ember install --save @heroku/ember-malibu-icon

Configuration

By default this addon will inject the latest version of Malibu. Consumers can configure this in their application's config/environment.js file

ENV['ember-malibu-icon'] = {
  malibuVersion: '1.3.0'
}

Usage

From a Handlebars (.hbs) file

{{malibu-icon size='28' iconClass='gradient-dark-gray' name='app-28' title="Optional Title"}}

From a javascript file

import { malibuIcon } from '@heroku/ember-malibu-icon/helpers/malibu-icon';
malibuIcon({
  name: 'app-16',
  size: 16,
  iconClass: 'v-mid gradient-purple',
  title='Optional Title'
})

Development

• git clone https://github.com/heroku/ember-malibu-icon
• cd ember-malibu-icon
• yarn

Running

• ember serve
• Visit your app at http://localhost:4200.

Running Tests

• yarn test (Runs ember try:each to test your addon against multiple Ember versions)
• ember test
• ember test --server

Building

• ember build

For more information on using ember-cli, visit https://ember-cli.com/.

Releases

Notes

This library does its best to follow the principles of Semantic Versioning. Every effort should be made to ensure all non-major versions are released in a backwards compatible way.

Making a New Release

Once you are ready to make a new release follow these steps:

• Create a new branch
• Update the version number in package.json
• Commit your changes and open a PR

Publish your new version to npm with the command npm publish 🎉

Note that you must have publish access to the @heroku npm organization to successfully publish