SF Symbol Support

nandorojo · Mar 3, 2023 · 2f2ae28 · 2f2ae28
1 parent d7ac140
commit 2f2ae28
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -28,7 +28,9 @@
   "author": "Fernando Rojo <[email protected]> (https://github.com/nandorojo)",
   "license": "MIT",
   "homepage": "https://github.com/nandorojo/burnt#readme",
-  "dependencies": {},
+  "dependencies": {
+    "sf-symbols-typescript": "^1.0.0"
+  },
   "devDependencies": {
     "@types/react": "^18.0.25",
     "@types/react-native": "^0.70.6",

diff --git a/src/types.ts b/src/types.ts
@@ -1,10 +1,12 @@
+import type { SFSymbol } from "sf-symbols-typescript";
+
 export type IconParams = {
   ios: {
     /**
      * The name of an iOS-only SF Symbol. For a full list, see https://developer.apple.com/sf-symbols/.
      * @platform ios
      */
-    name: string;
+    name: SFSymbol;
     /**
      * Change the custom icon color, default is system blue.
      * @platform ios

diff --git a/yarn.lock b/yarn.lock
@@ -4132,6 +4132,11 @@ set-value@^2.0.0, set-value@^2.0.1:
     is-plain-object "^2.0.3"
     split-string "^3.0.1"
 
+sf-symbols-typescript@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/sf-symbols-typescript/-/sf-symbols-typescript-1.0.0.tgz#94e9210bf27e7583f9749a0d07bd4f4937ea488f"
+  integrity sha512-DkS7q3nN68dEMb4E18HFPDAvyrjDZK9YAQQF2QxeFu9gp2xRDXFMF8qLJ1EmQ/qeEGQmop4lmMM1WtYJTIcCMw==
+
 shebang-command@^1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-1.2.0.tgz#44aac65b695b03398968c39f363fee5deafdf1ea"