{"_id":"@cspanring/ember-font-awesome","_rev":"1-edd4017fca9df2547c85cc37118dd657","name":"@cspanring/ember-font-awesome","description":"An ember-cli addon for using Font Awesome icons in Ember applications.","dist-tags":{"latest":"3.1.0"},"versions":{"3.1.0":{"name":"@cspanring/ember-font-awesome","version":"3.1.0","description":"An ember-cli addon for using Font Awesome icons in Ember applications.","keywords":["ember-addon"],"license":"Unlicense","author":{"name":"Marten Schilstra","email":"mail@martenschilstra.nl"},"directories":{"doc":"doc","test":"tests"},"repository":{"type":"git","url":"git+https://github.com/cspanring/ember-font-awesome.git"},"scripts":{"build":"ember build","start":"ember server","test":"ember try:each"},"dependencies":{"broccoli-funnel":"^1.2.0","chalk":"^1.1.3","ember-cli-htmlbars":"^2.0.2","font-awesome":"^4.7.0","ember-cli-babel":"^6.6.0"},"devDependencies":{"broccoli-asset-rev":"^2.4.5","ember-ajax":"^3.0.0","ember-cli":"~2.16.2","ember-cli-dependency-checker":"^2.0.0","ember-cli-eslint":"^4.0.0","ember-cli-htmlbars-inline-precompile":"^1.0.0","ember-cli-inject-live-reload":"^1.4.1","ember-cli-qunit":"^4.0.0","ember-cli-release":"^0.2.9","ember-cli-shims":"^1.1.0","ember-cli-sri":"^2.1.0","ember-cli-uglify":"^2.0.0","ember-disable-prototype-extensions":"^1.1.2","ember-export-application-global":"^2.0.0","ember-load-initializers":"^1.0.0","ember-resolver":"^4.0.0","ember-source":"~2.16.0","loader.js":"^4.2.3"},"engines":{"node":"^4.5 || 6.* || >= 7.*"},"ember-addon":{"configPath":"tests/dummy/config","before":["ember-cli-sass","ember-cli-less"]},"gitHead":"d38110e5d0662c3f708496ce85e7fd6081666e05","bugs":{"url":"https://github.com/cspanring/ember-font-awesome/issues"},"homepage":"https://github.com/cspanring/ember-font-awesome#readme","_id":"@cspanring/ember-font-awesome@3.1.0","_npmVersion":"5.5.1","_nodeVersion":"8.9.3","_npmUser":{"name":"cspanring","email":"cspanring@gmail.com"},"maintainers":[{"name":"cspanring","email":"cspanring@gmail.com"}],"dist":{"integrity":"sha512-A3gA0IID3TbiAcaifvdfH+1RR79C6wSle77AWyjVL+0N8+cH2v6yrtApuFZsbvAnR57lEyHOyaAYHLtNW7pccg==","shasum":"803c62565328b090148d297d03a1c1bc1cd6b491","tarball":"https://registry.npmjs.org/@cspanring/ember-font-awesome/-/ember-font-awesome-3.1.0.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD/M2AX4NHhEzdMkjHalPZNpk9vTwj6FklGaSYUGv6JCAIhAIYvGRH4E2kDJZIHGnOcXQk2o2I15PRcR7zEViHcqZNM"}]},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ember-font-awesome-3.1.0.tgz_1513802232273_0.31523636542260647"}}},"readme":"# ember-font-awesome\n[![npm version](https://badge.fury.io/js/ember-font-awesome.svg)](http://badge.fury.io/js/ember-font-awesome)\n[![Build Status](https://travis-ci.org/martndemus/ember-font-awesome.svg?branch=master)](https://travis-ci.org/martndemus/ember-font-awesome)\n[![Ember Observer Score](http://emberobserver.com/badges/ember-font-awesome.svg)](http://emberobserver.com/addons/ember-font-awesome)\n\nAn [ember-cli](http://www.ember-cli.com) addon for using\n[Font Awesome](http://fortawesome.github.io/Font-Awesome/) icons in Ember\napplications.\n\n__WARNING__: _Please verify that you are reading the README corresponding with\nthe version of `ember-font-awesome` you are using._\n\n## Table of Contents\n\n* [Ember Version Compatibility](#ember-version-compatibility)\n* [Installing the Add-on](#installing-the-add-on)\n* [Using the Add-on](#using-the-add-on)\n* [Customize with Sass/Scss or Less](#customize-with-sassscss-or-less)\n* [Excluding assets](#excluding-assets)\n\n### Ember Version Compatibility\n\nPlease consult the table to check which version of `ember-font-awesome` you\nshould use:\n\nAddon version         | Ember version | Addon name\n----------------------|---------------|-----------------------\n`>= 2.0.0`, `< 3.0.0` | `>= 2.3.0`    | `ember-font-awesome`\n`>= 1.0.0`, `< 2.0.0` | `>= 1.11.0`   | `ember-cli-font-awesome`\n`>= 0.1.0`, `< 1.0.0` | `>= 1.13.0`   | `ember-cli-font-awesome`\n`0.0.9`               | `< 1.11.0`    | `ember-cli-font-awesome`\n\n### Installing the Add-on\n\nIn your application's directory:\n```bash\n$ ember install ember-font-awesome\n```\n\n### Using the Add-on\n\nUse the component in your Handlebars templates:\n\n```hbs\n{{fa-icon \"camera\"}}\n```\n\nThis will render:\n```html\n<i class=\"fa fa-camera\"></i>\n```\n\nTo see which icons are available please check the\n[complete list of Font Awesome icons](http://fortawesome.github.io/Font-Awesome/icons/)\n\nThe [Font Awesome examples](http://fortawesome.github.io/Font-Awesome/examples/)\nillustrate the various options and their effects. It should be fairly simple to\nmap these options to their `{{fa-icon}}` counterparts.\n\n## :sos: Looking for Help?\n\n- :warning: **Bug reports**: If your bug hasn't been reported yet, please [**open an issue**][new-issue]. Try to pick a short but descriptive title. Make sure you're using the latest version of *ember-font-awesome*. In the issue body, try to provide exact steps for reproduction, ideally with example code. If you can't, please include any and all error messages, as many details as possible and exact information on which Ember.js / ember-cli version and browser / OS you're using.\n- ![Slack Icon](https://i.imgur.com/Bjckhpc.png) **Slack**: We're happy to help you in our [**#e-font-awesome**][slack] Slack channel! You can [create an Ember Community Slack account][slackin] here for free.\n\n\n#### Larger Icons\n\n```hbs\n{{fa-icon \"star\" size=\"lg\"}}\n{{fa-icon \"star\" size=2}}\n{{fa-icon \"star\" size=3}}\n{{fa-icon \"star\" size=4}}\n{{fa-icon \"star\" size=5}}\n```\n\n#### Fixed Width Icons\n\n```hbs\n<div class=\"list-group\">\n  <a class=\"list-group-item\" href=\"#\">\n    {{fa-icon \"home\" fixedWidth=true}} Home\n  </a>\n  <a class=\"list-group-item\" href=\"#\">\n    {{fa-icon \"book\" fixedWidth=true}} Library\n  </a>\n</div>\n```\n\n#### List Icons\n\n```hbs\n{{#fa-list as |l|}}\n  <li>{{l.fa-icon \"check-square\"}}List icons</li>\n  <li>{{l.fa-icon \"check-square\"}}can be used</li>\n  <li>{{l.fa-icon \"spinner\" spin=true}}as bullets</li>\n  <li>{{l.fa-icon \"square\"}}in lists</li>\n{{/fa-list}}\n```\n\n#### Bordered & Pulled Icons\n\n```hbs\n<p>\n{{fa-icon \"quote-left\" pull=\"left\" border=true}}\n...tomorrow we will run faster, stretch out our arms farther...\nAnd then one fine morning— So we beat on, boats against the\ncurrent, borne back ceaselessly into the past.\n</p>\n```\n\n#### Animated Icons\n\n```hbs\n{{fa-icon \"spinner\" spin=true}}\n{{fa-icon \"circle-o-notch\" spin=true}}\n{{fa-icon \"refresh\" spin=true}}\n{{fa-icon \"cog\" spin=true}}\n{{fa-icon \"spinner\" pulse=true}}\n```\n\n#### Rotate & Flipped\n\n```hbs\n{{fa-icon \"shield\"}} normal\n{{fa-icon \"shield\" rotate=90}} rotated 90 degrees\n{{fa-icon \"shield\" rotate=180}} rotated 180 degrees\n{{fa-icon \"shield\" rotate=270}} rotated 270 degrees\n{{fa-icon \"shield\" flip=\"horizontal\"}} flipped horizontal\n{{fa-icon \"shield\" flip=\"vertical\"}} flipped vertical\n```\n\n#### Stacked Icons\n\n```hbs\n{{#fa-stack size=\"lg\" as |s|}}\n  {{s.stack-2x \"square-o\"}}\n  {{s.stack-1x \"twitter\"}}\n{{/fa-stack}}\n\n{{#fa-stack size=\"lg\" as |s|}}\n  {{s.stack-2x \"circle\"}}\n  {{s.stack-1x \"flag\" inverse=true}}\n{{/fa-stack}}\n\n{{#fa-stack size=\"lg\" as |s|}}\n  {{s.stack-2x \"square\"}}\n  {{s.stack-1x \"terminal\" inverse=true}}\n{{/fa-stack}}\n\n{{#fa-stack size=\"lg\" as |s|}}\n  {{s.stack-2x \"square\"}}\n  {{s.stack-1x \"terminal\" class=\"text-danger\"}}\n{{/fa-stack}}\n```\n\n#### The `aria-hidden` Attribute\n\nTo better support accessibility (i.e. screen readers), the helper adds the\n`aria-hidden` attribute by default:\n\n```hbs\n{{fa-icon \"star\"}}\n```\n\nResults in:\n```html\n<i class=\"fa fa-star\" aria-hidden=\"true\"></i>\n```\n\nTo remove the `aria-hidden` attribute:\n\n```hbs\n{{fa-icon \"star\" ariaHidden=false}}\n```\n\n#### The `aria-label` Attribute\n\nTo better support accessibility (i.e. screen readers), the helper adds an\noptional `aria-label` attribute:\n\n```hbs\n{{fa-icon \"star\" ariaLabel=\"Click Me\"}}\n```\n\nResults in:\n```html\n<i class=\"fa fa-star\" aria-label=\"Click Me\"></i>\n```\n\n#### Actions\n\nYou can respond to actions on the icon by passing on action handlers:\n\n```hbs\n{{fa-icon \"star\" click=(action \"myClickHandler\")}}\n```\n\n#### Tag Name\n\nUse `tagName` to control the generated markup:\n\n```hbs\n{{fa-icon \"star\" tagName=\"span\"}}\n```\nResults in:\n\n```html\n<span class=\"fa fa-star\"></span>\n```\n\n#### Custom Class Names\n\n```hbs\n{{fa-icon \"bicycle\" class=\"my-custom-class\"}}\n```\n\nResults in:\n\n```html\n<i class=\"fa fa-bicycle my-custom-class\"></i>\n```\n\n#### Title attribute\n\n```hbs\n{{fa-icon \"edit\" title=\"Edit the item\"}}\n```\n\nResults in:\n\n```html\n<i class=\"fa fa-edit\" title=\"Edit the item\"></i>\n```\n\n### Customize with Sass/Scss or Less\n\nIf you are using the ember-cli-sass or ember-cli-less addon, you can opt-in to\nthe Scss or Less version of font-awesome by adding the following configuration\nin `ember-cli-build.js`:\n\n```js\nvar app = new EmberApp({\n  'ember-font-awesome': {\n    useScss: true, // for ember-cli-sass\n    useLess: true  // for ember-cli-less\n  }\n});\n```\n\nThen in your `app.scss` or `app.less`:\n\n```scss\n@import \"font-awesome\";\n```\n\n### Excluding assets\n\nYou can configure the addon to _not_ import any assets (CSS or font files) by adding\nthe following configuration in `ember-cli-build.js`:\n\n```js\nvar app = new EmberApp({\n  'ember-font-awesome': {\n    includeFontAwesomeAssets: false\n  }\n});\n```\n\nYou can also configure the addon to _only_ import specific font formats by adding\nthe following configuration in `ember-cli-build.js`:\n\n**Default:** `['eot', 'svg', 'ttf', 'woff', 'woff2', 'otf']`\n\n```js\nvar app = new EmberApp({\n  'ember-font-awesome': {\n    fontFormats: ['woff', 'woff2']\n  }\n});\n```\n\nIn addition, you can configure the addon to exclude the font file assets entirely by adding\nthe following configuration in `ember-cli-build.js`:\n\n```js\nvar app = new EmberApp({\n  'ember-font-awesome': {\n    includeFontFiles: false\n  }\n});\n```\n\n### Output path\n\nYou can change the directory where the fonts are copied to using the following configuration:\n\n```js\nvar app = new EmberApp({\n  'ember-font-awesome': {\n    fontsOutput: \"/some/dir/\"\n  }\n});\n```\n\nThis is useful when you change the output paths for your ember app. By default, ember-font-awesome copies the font files to `/dist/fonts`. The addon produces a css file to load the fonts that will be included in the vendor css file and expect to find the fonts at `../fonts`. If the css directory is not at the same level as the fonts directory, the site won't load the fonts.\n\nFor example, moving the css directory to `/dist/assets/css` would require the fonts directory to be `/dist/assets/fonts` and the configuration would look like this:\n\n```js\nvar app = new EmberApp({\n    outputPaths: {\n        app: {\n            css: {\n                  app: \"/assets/css/app-name.css\",\n            },\n            js: \"/assets/js/app-name.js\",\n        },\n\n        vendor: {\n            css: \"/assets/css/vendor.css\",\n            js: \"/assets/js/vendor.js\",\n        },\n    },\n    'ember-font-awesome': {\n        fontsOutput: \"/assets/fonts\"\n    }\n});\n```\n\n## License\n\n[Public Domain](UNLICENSE)\n\n[slack]: https://embercommunity.slack.com/messages/C6UMSLS74/\n[slackin]: https://ember-community-slackin.herokuapp.com/\n[new-issue]: https://github.com/martndemus/ember-font-awesome/issues/new\n","maintainers":[{"name":"cspanring","email":"cspanring@gmail.com"}],"time":{"modified":"2022-04-05T02:02:45.462Z","created":"2017-12-20T20:37:13.509Z","3.1.0":"2017-12-20T20:37:13.509Z"},"homepage":"https://github.com/cspanring/ember-font-awesome#readme","keywords":["ember-addon"],"repository":{"type":"git","url":"git+https://github.com/cspanring/ember-font-awesome.git"},"author":{"name":"Marten Schilstra","email":"mail@martenschilstra.nl"},"bugs":{"url":"https://github.com/cspanring/ember-font-awesome/issues"},"license":"Unlicense","readmeFilename":"README.md"}