sf-symbols-typescript

TypeScript types for iOS SF Symbols 🍏

MIT License

Stars
39
Committers
2

Bot releases are hidden (Show)

sf-symbols-typescript - v2 Latest Release

Published by nandorojo 8 months ago

This release adds updated support for SF Symbols on newer versions of iOS. It also lets you specify which versions you want to use with the following compatibility table.

Globally

You can restrict the SFSymbol type to a specific version of SF Symbols through declaration merging.

This library exposes an interface called Overrides with a property SFSymbolsVersion that can be overidden.

declare module 'sf-symbols-typescript' {
  interface Overrides {
    // globally restrict symbols to those found in SF Symbols 4.2
    SFSymbolsVersion: '4.2'
  }
}

Individually

If you require more granular control, this library also exposes individual type definitions for each version of SF Symbols.

They are named with this pattern: SFSymbols{major}_{minor}

import type { SFSymbols4_2, SFSymbols5_0 } from 'sf-symbols-typescript'

Version Support Table

Here are the platforms supported by each version of SF Symbols:

SFSymbols iOS macOS tvOS visionOS watchOS
1.0 13.0 11.0 13.0 1.0 6.0
1.1 13.1 11.0 13.0 1.0 6.1
2.0 14.0 11.0 14.0 1.0 7.0
2.1 14.2 11.0 14.2 1.0 7.1
2.2 14.5 11.3 14.5 1.0 7.4
3.0 15.0 12.0 15.0 1.0 8.0
3.1 15.1 12.0 15.1 1.0 8.1
3.2 15.2 12.1 15.2 1.0 8.3
3.3 15.4 12.3 15.4 1.0 8.5
4.0 16.0 13.0 16.0 1.0 9.0
4.1 16.1 13.0 16.1 1.0 9.1
4.2 16.4 13.3 16.4 1.0 9.4
5.0 17.0 14.0 17.0 1.0 10.0

Thanks to @nderscore for the contribution at #3