π£ A collection of every symbol from SF Symbols.
MIT License
π£ A collection of every symbol from SF Symbols.
SF Symbols is a library of iconography from Apple, integrated into the San Francisco system fonts.
npm install symbolist
symbols
Import symbols
.
import { symbols } from "symbolist"
// symbols: {"0.circle": "τΈ", "0.circle.fill": "τΉ", ...}
getSymbol
Import getSymbol
.
import { getSymbol } from "symbolist"
Given a symbol name, getSymbol
will return its symbol (or undefined
for unknown symbols).
const symbol = getSymbol("scribble.variable")
// symbol: "τ€"
getSymbolName
Import getSymbolName
.
import { getSymbolName } from "symbolist"
Given a symbol, getSymbolName
will return its name (or undefined
for unknown symbols).
const name = getSymbolName("τ£³")
// name: "lasso.and.sparkles"
Symbols are extracted with the generate
commandβusing the SF Symbols app.
generate
prepares types along its symbols which means getSymbol
and getSymbolName
will validate symbol names when using TypeScript.
This package follows SF Symbols' versioning for major and minor versions.