@bradleyhodges/sfsymbols-types
Typescript companion package containing type definitions for the @bradleyhodges/sfsymbols and @bradleyhodges/sfsymbols-react packages.
SF Symbols is a library of over 7,000 symbols that are designed to integrate seamlessly with San Francisco, the system font for Apple platforms.
[!CAUTION] SF Symbols is licensed by Apple for use only on Apple platforms. Use of this package, or any of the other @bradleyhodges/sfsymbols- packages, outside of Apple platforms is NOT permitted.*
Usage
In most cases, you won't need to actually install this type package as the types are referenced in the icon and react component packages.
However, if for whatever reason you need to reference or extend the types, simply install the package to the root of your project:
pnpm add @bradleyhodges/sfsymbols-types@latest
Using SF Symbols Icons
You will need to install the following packages to use the icons in your project:
@bradleyhodges/sfsymbols– Contains the actual icons.@bradleyhodges/sfsymbols-react– Contains the React components for the using the icons.
pnpm add @bradleyhodges/sfsymbols@latest @bradleyhodges/sfsymbols-react@latest
For detailed usage instructions and more information about the SF Symbols project, see the base package: https://github.com/bradleyhodges/sfsymbols