{"_id":"@cshbicos/ui5-fontawesome","name":"@cshbicos/ui5-fontawesome","dist-tags":{"latest":"1.6.1"},"versions":{"1.6.1":{"name":"@cshbicos/ui5-fontawesome","version":"1.6.1","description":"A Font Awesome plugin for UI5","browser":"js/ui5-fontawesome.js","scripts":{"build":"gulp rebuild","commit":"git-cz","lint:commitlint":"commitlint -f origin/master -t HEAD","lint:eslint":"eslint . --ignore-path .gitignore","lint":"npm-run-all --parallel --continue-on-error lint:eslint lint:commitlint","prepare":"npm run build","test:coverage":"nyc mocha tests/**.spec.js","test:debug":"mocha --inspect-brk tests/**.spec.js","test:only":"mocha tests/**.spec.js","test:watch":"mocha --watch --reporter min tests/**.spec.js","test":"npm-run-all test:coverage lint"},"repository":{"type":"git","url":"git+https://github.com/cshbicos/ui5-fontawesome.git"},"keywords":["ui5","font","awesome","fontawesome","openui5","sapui5","icon"],"author":{"name":"Yuping Zuo","url":"https://github.com/zypA13510"},"contributors":[{"name":"Font Awesome","url":"https://fontawesome.com/"}],"license":"(MIT AND OFL-1.1)","bugs":{"url":"https://github.com/zypA13510/ui5-fontawesome/issues"},"homepage":"https://github.com/zypA13510/ui5-fontawesome#readme","dependencies":{"@fortawesome/fontawesome-free":"^6.4.2"},"devDependencies":{"@commitlint/config-conventional":"^8.3.4","@commitlint/prompt":"^8.3.5","@semantic-release/changelog":"^5.0.1","@semantic-release/exec":"^5.0.0","@semantic-release/git":"^9.0.0","bluebird":"^3.7.2","chai":"^4.2.0","chai-as-promised":"^7.1.1","commitizen":"^4.0.3","commitlint":"^8.3.5","commitlint-format-junit":"^1.1.4","coveralls":"^3.0.11","del":"^5.1.0","eslint":"^6.8.0","fs-extra":"^9.0.0","glob":"^7.1.6","gulp":"^4.0.2","gulp-decompress":"^3.0.0","gulp-rename":"^2.0.0","gulp-sourcemaps":"^2.6.5","gulp-uglify":"^3.0.2","gulp-zip":"^5.0.1","jquery":"^3.5.0","js-yaml":"^3.13.1","jsdom":"^16.2.2","lodash.pickby":"^4.6.0","mocha":"^7.1.1","mocha-junit-reporter":"^1.23.3","npm-run-all":"^4.1.5","nyc":"^15.0.1","request":"^2.88.2","semantic-release":"^17.0.4","semver":"^7.2.1","sinon":"^9.0.1","sinon-chai":"^3.5.0","ui5-simple-require":"^2.0.0","vinyl":"^2.2.0"},"config":{"commitizen":{"path":"@commitlint/prompt"}},"commitlint":{"extends":["@commitlint/config-conventional"]},"release":{"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator",["@semantic-release/changelog",{"changelogFile":"CHANGELOG.md","changelogTitle":"CHANGELOG"}],["@semantic-release/npm",{"tarballDir":"dist"}],"@semantic-release/git",["@semantic-release/exec",{"generateNotesCmd":"npx gulp --silent printversion","prepareCmd":"npx gulp pack --packageversion ${nextRelease.version}","successCmd":"npx gulp clean","failCmd":"npx gulp clean"}],["@semantic-release/github",{"assets":"dist/*.zip"}]]},"_id":"@cshbicos/ui5-fontawesome@1.6.1","gitHead":"9e4bb2ffdf6d7801e3f8e108db9b9c51bc206d15","_nodeVersion":"18.17.1","_npmVersion":"9.8.1","dist":{"integrity":"sha512-XVlETuhg/QJZ5bejPtGx/IQslMfSvEeG6GpnoI8uOO0T9aLmBy54rwdPrw5eBQu5I4EmP0eQLuQdYKLPeYCDfw==","shasum":"7817eeb9e138e33d15e42f32d9c95043339fbf31","tarball":"https://registry.npmjs.org/@cshbicos/ui5-fontawesome/-/ui5-fontawesome-1.6.1.tgz","fileCount":19,"unpackedSize":1022865,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDnUHldOK4QRk1xNnHXJ9FhtYp2NaPsBBuFnDY+cZ3u7AIhALW1jZdpWX7nsLQKShBX5RutkM3xjUhLXGxpEWcXwcIf"}]},"_npmUser":{"name":"cshbicos","email":"csh.mrman@gmail.com"},"directories":{},"maintainers":[{"name":"cshbicos","email":"csh.mrman@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ui5-fontawesome_1.6.1_1693558953661_0.7253746981958953"},"_hasShrinkwrap":false}},"time":{"created":"2023-09-01T09:02:33.534Z","1.6.1":"2023-09-01T09:02:33.921Z","modified":"2023-09-01T09:02:34.166Z"},"maintainers":[{"name":"cshbicos","email":"csh.mrman@gmail.com"}],"description":"A Font Awesome plugin for UI5","homepage":"https://github.com/zypA13510/ui5-fontawesome#readme","keywords":["ui5","font","awesome","fontawesome","openui5","sapui5","icon"],"repository":{"type":"git","url":"git+https://github.com/cshbicos/ui5-fontawesome.git"},"contributors":[{"name":"Font Awesome","url":"https://fontawesome.com/"}],"author":{"name":"Yuping Zuo","url":"https://github.com/zypA13510"},"bugs":{"url":"https://github.com/zypA13510/ui5-fontawesome/issues"},"license":"(MIT AND OFL-1.1)","readme":"<h1 align=\"center\" style=\"border-bottom: none;\">ui5-fontawesome</h1>\n<p align=\"center\">A <a href=\"https://fontawesome.com/\">Font Awesome</a> plugin for <a href=\"https://openui5.org/\">OpenUI5</a>/SAPUI5.</p>\n<p align=\"center\">\n    <a href=\"https://circleci.com/gh/zypA13510/ui5-fontawesome\">\n        <img alt=\"CircleCI build status\" src=\"https://img.shields.io/circleci/project/github/zypA13510/ui5-fontawesome/master.svg?logo=CircleCI&style=flat-square\">\n    </a>\n    <a href=\"https://coveralls.io/github/zypA13510/ui5-fontawesome\">\n        <img alt=\"Coveralls coverage status\" src=\"https://img.shields.io/coveralls/github/zypA13510/ui5-fontawesome.svg?logo=coveralls&style=flat-square\">\n    </a>\n    <a href=\"https://codeclimate.com/github/zypA13510/ui5-fontawesome/maintainability\">\n        <img alt=\"Code Climate maintainability rating\" src=\"https://img.shields.io/codeclimate/maintainability/zypA13510/ui5-fontawesome.svg?logo=Code-Climate&style=flat-square\">\n    </a>\n    <a href=\"https://snyk.io/test/npm/ui5-fontawesome\">\n        <img alt=\"Snyk known vulnerabilities\" src=\"https://img.shields.io/snyk/vulnerabilities/npm/ui5-fontawesome.svg?logo=Snyk&style=flat-square\">\n    </a>\n    <br>\n    <a href=\"https://www.npmjs.com/package/ui5-fontawesome\">\n        <img alt=\"NPM version\" src=\"https://img.shields.io/npm/v/ui5-fontawesome.svg?logo=npm&style=flat-square\">\n    </a>\n    <a href=\"https://www.npmjs.com/package/ui5-fontawesome\">\n        <img alt=\"NPM download count\" src=\"https://img.shields.io/npm/dm/ui5-fontawesome.svg?logo=npm&style=flat-square\">\n    </a>\n    <a href=\"https://www.jsdelivr.com/package/npm/ui5-fontawesome\">\n        <img alt=\"jsDelivr hits\" src=\"https://img.shields.io/jsdelivr/npm/hm/ui5-fontawesome.svg?logo=jsdelivr&style=flat-square\">\n    </a>\n    <a href=\"https://github.com/zypA13510/ui5-fontawesome/releases\">\n        <img alt=\"GitHub download count\" src=\"https://img.shields.io/github/downloads/zypA13510/ui5-fontawesome/total.svg?logo=GitHub&style=flat-square\">\n    </a>\n    <br>\n    <a href=\"https://greenkeeper.io/\">\n        <img alt=\"Greenkeeper enabled\" src=\"https://img.shields.io/badge/Greenkeeper-enabled-brightgreen.svg?logo=Greenkeeper&style=flat-square\">\n    </a>\n    <a href=\"https://github.com/semantic-release/semantic-release\">\n        <img alt=\"semantic-release\" src=\"https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square\">\n    </a>\n    <a href=\"https://conventionalcommits.org/\">\n        <img alt=\"Conventional Commits\" src=\"https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square\">\n    </a>\n    <a href=\"http://commitizen.github.io/cz-cli/\">\n        <img alt=\"commitizen friendly\" src=\"https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square\">\n    </a>\n</p>\n\n\n## Usage\n### Bootstrapping\n#### Hosting On-Premise\n1. Download the package and put it somewhere in your app folder (please keep the folder structure).\n2. Add the following to your HTML after the bootstrapping of OpenUI5 (change `src` accordingly):\n    ```HTML\n    <script\n      src=\"../node_modules/ui5-fontawesome/js/ui5-fontawesome.min.js\"\n      id=\"ui5-fontawesome\">\n    </script>\n    ```\n    The `id=\"ui5-fontawesome\"` is required. Additionally, if the folder is not named `ui5-fontawesome`, you need to specify the path to the package relative to the HTML file by adding a `data-resourceroot` attribute. For example:\n    ```HTML\n    <script\n      src=\"../not-ui5-fontawesome/js/ui5-fontawesome.min.js\"\n      id=\"ui5-fontawesome\"\n      data-resourceroot=\"../not-ui5-fontawesome/\">\n    </script>\n    ```\n#### Bootstrapping from CDN\nAdd one of the following to your HTML after the bootstrapping of OpenUI5. **Note:** It is advised to specify at least a major version to avoid breaking your app, change `^1` to your desired [semver range](https://docs.npmjs.com/misc/semver#ranges) accordingly. Additionally, you may want to pinpoint a specific version if you wish to use [SRI check](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity).\n##### jsDelivr\n```HTML\n<script\n  src=\"https://cdn.jsdelivr.net/npm/ui5-fontawesome@^1/js/ui5-fontawesome.min.js\"\n  id=\"ui5-fontawesome\"\n  data-resourceroot=\"https://cdn.jsdelivr.net/npm/ui5-fontawesome@^1/\">\n</script>\n```\n##### UNPKG\n```HTML\n<script\n  src=\"https://unpkg.com/ui5-fontawesome@^1/js/ui5-fontawesome.min.js\"\n  id=\"ui5-fontawesome\"\n  data-resourceroot=\"https://unpkg.com/ui5-fontawesome@^1/\">\n</script>\n```\n### Use in Views and Controllers\nTo use the font in UI5 application, prepend `fa-brands`/`fa-regular`/`fa-solid`, depending on your desired style, to the [icon name](https://fontawesome.com/icons) (only free icon-style combinations are supported):\n```XML\n<mvc:View\n  xmlns=\"sap.m\"\n  xmlns:mvc=\"sap.ui.core.mvc\"\n  xmlns:core=\"sap.ui.core\">\n  <core:Icon src=\"sap-icon://fa-brands/font-awesome\" size=\"2.5rem\" color=\"#339AF0\" class=\"sapUiTinyMargin\"/>\n  <Button icon=\"sap-icon://fa-regular/closed-captioning\" class=\"sapUiTinyMargin\"/>\n  <StandardListItem icon=\"sap-icon://fa-solid/award\" title=\"This is awesome.\"/>\n</mvc:View>\n```\n```JavaScript\nsap.ui.define([\n  'sap/ui/core/Icon'\n], function(\n  Icon\n) {\n  return new Icon({\n    src: 'sap-icon://fa-brands/font-awesome',\n    size: '2.5rem',\n    color: '#339AF0'\n  });\n});\n```\n\n## Changelog\nSee [CHANGELOG.md](CHANGELOG.md).\n\n## License\nThe code contained in this repository is licensed under MIT license.\n\nAdditionally, the distributed package contains part of the Font Awesome free package, you can find the license from [their repository](https://github.com/FortAwesome/Font-Awesome/blob/master/LICENSE.txt) or `fontawesome-free/LICENSE.txt` in your download.\n\nThis project is not endorsed by or affiliated with either Font Awesome or OpenUI5.\n","readmeFilename":"README.md"}