sf-symbols-typescript

import type { SFSymbol } from 'sf-symbols-typescript'; // Basic usage: type-checking SF Symbol names const basicIcon: SFSymbol = 'arrow.up'; // const invalidIcon: SFSymbol = 'non.existent.symbol'; // This would cause a TypeScript error // Globally restricting SF Symbol versions using declaration merging declare module 'sf-symbols-typescript' { interface Overrides { // Restrict symbols to those found in SF Symbols 5.0 (e.g., for iOS 17.0+) SFSymbolsVersion: '5.0'; } } // After declaration merging, SFSymbol now only includes 5.0 symbols. // This ensures your app only uses symbols available on its minimum target OS. const restrictedIcon: SFSymbol = 'faceid'; // 'faceid' is available in 5.0 // const newerIcon: SFSymbol = 'globe.desk'; // If 'globe.desk' was introduced in 6.0, this would now be a type error // Alternatively, importing specific version types for granular control import type { SFSymbols6_0 } from 'sf-symbols-typescript'; const specificVersionIcon: SFSymbols6_0 = 'globe.desk'; // Explicitly use a 6.0 symbol type console.log(`Using basic icon: ${basicIcon}`); console.log(`Using restricted icon: ${restrictedIcon}`); console.log(`Using specific version icon: ${specificVersionIcon}`); // This library has no runtime code, so these lines just demonstrate type usage. // In a real app, you would pass these strings to a native UI component.