Skip to content

pantoken / packages/core/src / collectIcons

Function: collectIcons()

collectIcons(options?): IconLayer

Beta

Collect the unified InstUI icon layer. Custom glyphs take precedence over same-named Lucide glyphs. Output is sorted by name for deterministic results.

Parameters

options?

CollectIconsOptions = {}

Returns

IconLayer

Examples

Collect every glyph plus the icon-colour special values

ts
import { collectIcons } from "@pantoken/core";

const { glyphs, colors } = collectIcons();
// glyphs → IconToken[] (Custom + Lucide, name-sorted)
// colors → [["--instui-icon-color-ai", "…"], ["--instui-icon-color-inherit", "currentColor"]]

Restrict to Instructure-authored glyphs only

ts
import { collectIcons } from "@pantoken/core";

const { glyphs } = collectIcons({ includeLucide: false });
// → only the Custom (Instructure-authored) glyphs