diff options
Diffstat (limited to 'themes/docsy/assets/vendor/Font-Awesome/js-packages/@fortawesome/fontawesome-common-types/README.md')
| -rw-r--r-- | themes/docsy/assets/vendor/Font-Awesome/js-packages/@fortawesome/fontawesome-common-types/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/themes/docsy/assets/vendor/Font-Awesome/js-packages/@fortawesome/fontawesome-common-types/README.md b/themes/docsy/assets/vendor/Font-Awesome/js-packages/@fortawesome/fontawesome-common-types/README.md new file mode 100644 index 0000000..f81cf2a --- /dev/null +++ b/themes/docsy/assets/vendor/Font-Awesome/js-packages/@fortawesome/fontawesome-common-types/README.md @@ -0,0 +1,27 @@ +# @fortawesome/fontawesome-common-types - SVG with JavaScript + +> "I came here to chew bubblegum and install Font Awesome 5 - and I'm all out of bubblegum" + +[](https://www.npmjs.com/package/@fortawesome/fontawesome-common-types) + +## What is this package? + +Font Awesome 5 JavaScript packages support TypeScript. This package abstracts out some of the common definitions that those packages use. + +## Here be dragons + +If you are trying to import types from this package we *highly* recommend you do the following instead as *all types in this package are re-exported to the main fontawesome package*. + +your.ts + +``` +import { + IconName +} from `@fortawesome/fontawesome` + +const myIcon: IconName = "..." +``` + +## Issues and support + +Start with [GitHub issues](https://github.com/FortAwesome/Font-Awesome/issues) and ping us on [Twitter](https://twitter.com/fontawesome) if you need to. |