🔣 A collection of every symbol from SF Symbols.

• 🤖 Automated: Authored and updated automatically
• 🧪 Reliable: Fully tested with 100% code coverage
• 📦 Typed: Written in TypeScript and includes definitions out-of-the-box
• 💨 Zero dependencies

SF Symbols is a library of iconography from Apple, integrated into the San Francisco system fonts.

npm install symbolist

Import symbols.

import { symbols } from "symbolist"

// symbols: {"0.circle": "􀀸", "0.circle.fill": "􀀹", ...}

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: "􀤑"

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.