@fiscozen/icons 0.1.0

package/.eslintignore

@@ -0,0 +1 @@
+dist

package/.eslintrc.cjs

@@ -0,0 +1,7 @@
+/* eslint-env node */
+require('@rushstack/eslint-patch/modern-module-resolution')
+
+module.exports = {
+  root: true,
+  'extends': ['@fiscozen/eslint-config', 'plugin:storybook/recommended']
+}

package/.prettierrc.js

@@ -0,0 +1,6 @@
+import fiscozenPrettierConfig from '@fiscozen/prettier-config';
+
+export default {
+    ...fiscozenPrettierConfig
+    // place overrides here
+};

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Fiscozen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# @fiscozen/icons
+
+## Notes
+
+- For the current iteration we decided to ship icons in a bundle (svg + js style), no API or lazy loading is currently happening
+- In order to keep the bundle size low we are leveraging the "incon kits" Pro Font Awesome feature, therefore tailoring the icon set that we ship. In order to install the design system users therefore need to configure a `.npmrc` in the application root folder, use the one in this repo as a guideline.
+To avoid exposing secrets the Font Awesome Pro token should be configured in a environment variable as `FONTAWESOME_PACKAGE_TOKEN`

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@fiscozen/icons",
+  "version": "0.1.0",
+  "description": "Design system icon plugin and component",
+  "main": "src/index.ts",
+  "type": "module",
+  "keywords": [],
+  "author": "Riccardo Agnoletto",
+  "license": "ISC",
+  "peerDependencies": {
+    "vue": "^3.4.13"
+  },
+  "devDependencies": {
+    "@fiscozen/eslint-config": "^0.1.0",
+    "@fiscozen/prettier-config": "^0.1.0",
+    "@fiscozen/tsconfig": "^0.1.0"
+  },
+  "dependencies": {
+    "@awesome.me/kit-8137893ad3": "^1.0.65",
+    "@fortawesome/fontawesome-svg-core": "^6.5.1",
+    "@fortawesome/vue-fontawesome": "^3.0.6"
+  },
+  "scripts": {
+    "format": "prettier --write src/",
+    "test": "exit 0;",
+    "build": "exit 0;"
+  }
+}

package/src/FzIcon.vue

@@ -0,0 +1,21 @@
+<script setup lang="ts">
+import { FontAwesomeIcon } from '@fortawesome/vue-fontawesome'
+import { byPrefixAndName } from '@awesome.me/kit-8137893ad3/icons'
+import type { IconSize, IconVariant } from './types'
+
+withDefaults(
+  defineProps<{
+    name: string | string[]
+    size?: IconSize
+    variant?: IconVariant
+  }>(),
+  { size: 'lg', variant: 'far' }
+)
+</script>
+
+<template>
+  <font-awesome-icon
+    :icon="typeof name === 'string' ? byPrefixAndName[variant][name] : name"
+    :size="size !== 'md' ? size : undefined"
+  />
+</template>

package/src/index.ts

@@ -0,0 +1,16 @@
+import { Plugin } from 'vue'
+import { library } from '@fortawesome/fontawesome-svg-core'
+import { all } from '@awesome.me/kit-8137893ad3/icons'
+import FzIcon from './FzIcon.vue'
+
+const IconPlugin : Plugin = {
+  install(app) {
+    // @ts-ignore
+    library.add(...all)
+    app.component('fz-icon', FzIcon)
+  }
+}
+
+export { FzIcon, IconPlugin }
+
+export type { IconVariant, IconSize } from './types'

package/src/types.ts

@@ -0,0 +1,4 @@
+type IconVariant = 'fas' | 'far' | 'fal' | 'fat' | 'fad' | 'fass' | 'fasr' | 'fasl' | 'fast' | 'fak'
+type IconSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl'
+
+export type { IconVariant, IconSize }

package/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@fiscozen/tsconfig"
+}