JSDoc

Resolve an icon component by design name. Throws on unknown names — an unknown icon is a programming error (the `IconName` union should have caught it), never something to silently render as an empty box.

getIcon(name: IconName): IconComponent

Props every icon component accepts (lucide adds `size` on top of SvgProps).

type IconComponentProps = any

type IconComponent = ComponentType<any>

The closed union of valid icon names. Invalid names are compile errors.

type IconName = "activity" | "alert-triangle" | "archive" | "arrow-down" | "arrow-left" | "arrow-right" | "arrow-up" | "arrow-up-down" | "ban" | "bar-chart-3" | "bell" | "bell-dot" | "book" | "book-image" | "book-open" | "bookmark" | "bot" | "box" | "braces" | "brain" | "bug" | "calendar" | "calendar-check" | "calendar-clock" | "calendar-days" | "calendar-x-2" | "check" | "check-check" | "check-circle-2" | "chevron-down" | "chevron-left" | "chevron-right" | "chevron-up" | "chevrons-down" | "chevrons-left" | "chevrons-right" | "chevrons-up" | "chevrons-up-down" | "circle" | "circle-alert" | "circle-check" | "circle-check-big" | "circle-dashed" | "circle-dot" | "circle-play" | "circle-question-mark" | "circle-slash" | "clipboard-check" | "clipboard-list" | "clock" | "cloud" | "cloud-check" | "cloud-off" | "code" | "columns-2" | "command" | "component" | "construction" | "copy" | "corner-down-right" | "database" | "dollar-sign" | "download" | "ellipsis" | "eraser" | "expand" | "external-link" | "eye" | "eye-off" | "file" | "file-check" | "file-code" | "file-code-2" | "file-json" | "file-plus" | "file-plus-2" | "file-question" | "file-text" | "file-warning" | "file-x" | "files" | "filter" | "filter-x" | "fingerprint" | "flag" | "flame" | "flask-conical" | "folder" | "folder-open" | "folder-plus" | "folder-tree" | "folder-x" | "frame" | "gauge" | "git-branch" | "git-branch-plus" | "git-commit-horizontal" | "git-fork" | "git-merge" | "git-pull-request" | "globe" | "grip-vertical" | "group" | "hand" | "hash" | "heart" | "help-circle" | "history" | "home" | "hourglass" | "house" | "image" | "image-plus" | "images" | "inbox" | "info" | "kanban" | "key" | "key-round" | "keyboard" | "layers" | "layout-dashboard" | "layout-grid" | "layout-list" | "lightbulb" | "link" | "link-2-off" | "list" | "list-checks" | "list-collapse" | "list-todo" | "loader" | "loader-circle" | "lock" | "lock-open" | "log-out" | "maximize-2" | "menu" | "message-circle" | "message-square" | "mic" | "minus" | "monitor-down" | "moon" | "more-horizontal" | "mouse-pointer-2" | "newspaper" | "octagon-alert" | "octagon-x" | "package" | "package-check" | "panel-left" | "paperclip" | "pause" | "pen-tool" | "pencil" | "pencil-off" | "play" | "plug" | "plus" | "power-off" | "refresh-cw" | "refresh-cw-off" | "repeat" | "rotate-ccw" | "rotate-cw" | "rows-3" | "save" | "scissors" | "scroll-text" | "search" | "search-x" | "send" | "server" | "server-crash" | "settings" | "shapes" | "share" | "share-2" | "shield" | "shield-alert" | "shield-check" | "shield-x" | "skull" | "smartphone" | "sliders-horizontal" | "sparkles" | "spline" | "split" | "square" | "square-check" | "square-pen" | "star" | "sticky-note" | "sun" | "table" | "table-2" | "tag" | "telescope" | "terminal" | "timer" | "timer-off" | "trash-2" | "triangle-alert" | "type" | "undo-2" | "unplug" | "upload" | "user" | "user-plus" | "user-round-x" | "user-x" | "users" | "vault" | "wifi" | "wifi-off" | "wind" | "workflow" | "wrench" | "x" | "zap"

const iconRegistry: Readonly<Record<"activity" | "alert-triangle" | "archive" | "arrow-down" | "arrow-left" | "arrow-right" | "arrow-up" | "arrow-up-down" | "ban" | "bar-chart-3" | "bell" | "bell-dot" | "book" | "book-image" | "book-open" | "bookmark" | "bot" | "box" | "braces" | "brain" | "bug" | "calendar" | "calendar-check" | "calendar-clock" | "calendar-days" | "calendar-x-2" | "check" | "check-check" | "check-circle-2" | "chevron-down" | "chevron-left" | "chevron-right" | "chevron-up" | "chevrons-down" | "chevrons-left" | "chevrons-right" | "chevrons-up" | "chevrons-up-down" | "circle" | "circle-alert" | "circle-check" | "circle-check-big" | "circle-dashed" | "circle-dot" | "circle-play" | "circle-question-mark" | "circle-slash" | "clipboard-check" | "clipboard-list" | "clock" | "cloud" | "cloud-check" | "cloud-off" | "code" | "columns-2" | "command" | "component" | "construction" | "copy" | "corner-down-right" | "database" | "dollar-sign" | "download" | "ellipsis" | "eraser" | "expand" | "external-link" | "eye" | "eye-off" | "file" | "file-check" | "file-code" | "file-code-2" | "file-json" | "file-plus" | "file-plus-2" | "file-question" | "file-text" | "file-warning" | "file-x" | "files" | "filter" | "filter-x" | "fingerprint" | "flag" | "flame" | "flask-conical" | "folder" | "folder-open" | "folder-plus" | "folder-tree" | "folder-x" | "frame" | "gauge" | "git-branch" | "git-branch-plus" | "git-commit-horizontal" | "git-fork" | "git-merge" | "git-pull-request" | "globe" | "grip-vertical" | "group" | "hand" | "hash" | "heart" | "help-circle" | "history" | "home" | "hourglass" | "house" | "image" | "image-plus" | "images" | "inbox" | "info" | "kanban" | "key" | "key-round" | "keyboard" | "layers" | "layout-dashboard" | "layout-grid" | "layout-list" | "lightbulb" | "link" | "link-2-off" | "list" | "list-checks" | "list-collapse" | "list-todo" | "loader" | "loader-circle" | "lock" | "lock-open" | "log-out" | "maximize-2" | "menu" | "message-circle" | "message-square" | "mic" | "minus" | "monitor-down" | "moon" | "more-horizontal" | "mouse-pointer-2" | "newspaper" | "octagon-alert" | "octagon-x" | "package" | "package-check" | "panel-left" | "paperclip" | "pause" | "pen-tool" | "pencil" | "pencil-off" | "play" | "plug" | "plus" | "power-off" | "refresh-cw" | "refresh-cw-off" | "repeat" | "rotate-ccw" | "rotate-cw" | "rows-3" | "save" | "scissors" | "scroll-text" | "search" | "search-x" | "send" | "server" | "server-crash" | "settings" | "shapes" | "share" | "share-2" | "shield" | "shield-alert" | "shield-check" | "shield-x" | "skull" | "smartphone" | "sliders-horizontal" | "sparkles" | "spline" | "split" | "square" | "square-check" | "square-pen" | "star" | "sticky-note" | "sun" | "table" | "table-2" | "tag" | "telescope" | "terminal" | "timer" | "timer-off" | "trash-2" | "triangle-alert" | "type" | "undo-2" | "unplug" | "upload" | "user" | "user-plus" | "user-round-x" | "user-x" | "users" | "vault" | "wifi" | "wifi-off" | "wind" | "workflow" | "wrench" | "x" | "zap", ComponentType<any>>>

const iconNames: ReadonlyArray<"activity" | "alert-triangle" | "archive" | "arrow-down" | "arrow-left" | "arrow-right" | "arrow-up" | "arrow-up-down" | "ban" | "bar-chart-3" | "bell" | "bell-dot" | "book" | "book-image" | "book-open" | "bookmark" | "bot" | "box" | "braces" | "brain" | "bug" | "calendar" | "calendar-check" | "calendar-clock" | "calendar-days" | "calendar-x-2" | "check" | "check-check" | "check-circle-2" | "chevron-down" | "chevron-left" | "chevron-right" | "chevron-up" | "chevrons-down" | "chevrons-left" | "chevrons-right" | "chevrons-up" | "chevrons-up-down" | "circle" | "circle-alert" | "circle-check" | "circle-check-big" | "circle-dashed" | "circle-dot" | "circle-play" | "circle-question-mark" | "circle-slash" | "clipboard-check" | "clipboard-list" | "clock" | "cloud" | "cloud-check" | "cloud-off" | "code" | "columns-2" | "command" | "component" | "construction" | "copy" | "corner-down-right" | "database" | "dollar-sign" | "download" | "ellipsis" | "eraser" | "expand" | "external-link" | "eye" | "eye-off" | "file" | "file-check" | "file-code" | "file-code-2" | "file-json" | "file-plus" | "file-plus-2" | "file-question" | "file-text" | "file-warning" | "file-x" | "files" | "filter" | "filter-x" | "fingerprint" | "flag" | "flame" | "flask-conical" | "folder" | "folder-open" | "folder-plus" | "folder-tree" | "folder-x" | "frame" | "gauge" | "git-branch" | "git-branch-plus" | "git-commit-horizontal" | "git-fork" | "git-merge" | "git-pull-request" | "globe" | "grip-vertical" | "group" | "hand" | "hash" | "heart" | "help-circle" | "history" | "home" | "hourglass" | "house" | "image" | "image-plus" | "images" | "inbox" | "info" | "kanban" | "key" | "key-round" | "keyboard" | "layers" | "layout-dashboard" | "layout-grid" | "layout-list" | "lightbulb" | "link" | "link-2-off" | "list" | "list-checks" | "list-collapse" | "list-todo" | "loader" | "loader-circle" | "lock" | "lock-open" | "log-out" | "maximize-2" | "menu" | "message-circle" | "message-square" | "mic" | "minus" | "monitor-down" | "moon" | "more-horizontal" | "mouse-pointer-2" | "newspaper" | "octagon-alert" | "octagon-x" | "package" | "package-check" | "panel-left" | "paperclip" | "pause" | "pen-tool" | "pencil" | "pencil-off" | "play" | "plug" | "plus" | "power-off" | "refresh-cw" | "refresh-cw-off" | "repeat" | "rotate-ccw" | "rotate-cw" | "rows-3" | "save" | "scissors" | "scroll-text" | "search" | "search-x" | "send" | "server" | "server-crash" | "settings" | "shapes" | "share" | "share-2" | "shield" | "shield-alert" | "shield-check" | "shield-x" | "skull" | "smartphone" | "sliders-horizontal" | "sparkles" | "spline" | "split" | "square" | "square-check" | "square-pen" | "star" | "sticky-note" | "sun" | "table" | "table-2" | "tag" | "telescope" | "terminal" | "timer" | "timer-off" | "trash-2" | "triangle-alert" | "type" | "undo-2" | "unplug" | "upload" | "user" | "user-plus" | "user-round-x" | "user-x" | "users" | "vault" | "wifi" | "wifi-off" | "wind" | "workflow" | "wrench" | "x" | "zap">