> ## Documentation Index
> Fetch the complete documentation index at: https://prefab.prefect.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Icon
> Render any lucide icon by name.
export const ComponentPreview = ({json, height, resizable, bare, hideJson, playground, children}) => {
const hostRef = React.useRef(null);
const handleRef = React.useRef(null);
const cardRef = React.useRef(null);
const containerRef = React.useRef(null);
const [previewWidth, setPreviewWidth] = React.useState(null);
const [isDragging, setIsDragging] = React.useState(false);
const [playgroundHref, setPlaygroundHref] = React.useState(null);
React.useEffect(function () {
if (!playground) return;
var isLocal = location.hostname === "localhost" || location.hostname === "127.0.0.1";
var path = isLocal ? "/playground" : "/docs/playground";
var url = new URL(path, window.location.href);
url.hash = "code=" + playground;
setPlaygroundHref(url.href);
}, [playground]);
var jsonStr = typeof json === "string" ? json : JSON.stringify(json, null, 2);
React.useEffect(function () {
if (cardRef.current) {
var card = cardRef.current.closest(".group");
if (card) card.classList.remove("group");
}
var host = hostRef.current;
if (!host || !json) return;
function mount() {
if (!window.__prefab || !host) return;
var dark = document.documentElement.classList.contains("dark");
handleRef.current = window.__prefab.mountPreview(host, jsonStr, {
dark: dark
});
if (bare && host.shadowRoot) {
var m = host.shadowRoot.querySelector("[data-prefab-mount]");
if (m) m.style.background = "transparent";
}
}
if (window.__prefab) {
mount();
} else {
if (!window.__prefabLoading) {
if (!window.__prefabReady) {
var s = document.createElement("script");
s.src = "/renderer.js";
document.head.appendChild(s);
}
window.__prefabLoading = new Promise(function (resolve) {
function check() {
if (window.__prefabReady) {
window.__prefabReady.then(resolve);
} else {
setTimeout(check, 10);
}
}
check();
});
}
window.__prefabLoading.then(mount);
}
var observer = new MutationObserver(function () {
var dark = document.documentElement.classList.contains("dark");
if (handleRef.current) handleRef.current.setDark(dark);
});
observer.observe(document.documentElement, {
attributes: true,
attributeFilter: ["class"]
});
return function () {
observer.disconnect();
if (handleRef.current) {
handleRef.current.unmount();
handleRef.current = null;
}
};
}, [json]);
function startResize(e) {
e.preventDefault();
var startX = e.clientX;
var startW = hostRef.current ? hostRef.current.offsetWidth : 0;
var maxW = containerRef.current ? containerRef.current.offsetWidth - 10 : startW;
setIsDragging(true);
function onMove(ev) {
var w = Math.max(260, Math.min(startW + (ev.clientX - startX), maxW));
setPreviewWidth(w);
}
function onUp() {
document.removeEventListener("mousemove", onMove);
document.removeEventListener("mouseup", onUp);
setIsDragging(false);
}
document.addEventListener("mousemove", onMove);
document.addEventListener("mouseup", onUp);
}
if (bare) {
return ;
}
if (resizable) {
return
{previewWidth &&
{previewWidth}px
}
{playgroundHref && }
{children}
;
}
return
{playgroundHref && }
{children}
;
};
Icons render any [lucide icon](https://lucide.dev/icons) by name. Pass the icon name in kebab-case and it resolves at render time.
## Basic Usage
```python Python icon="python" theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}}
from prefab_ui.components import Icon
Icon("rocket")
```
```json Protocol icon="brackets-curly" theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}}
{"view": {"type": "Icon", "name": "rocket", "size": "default"}}
```
## Sizes
Three size variants control the icon dimensions.
```python Python icon="python" theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}}
from prefab_ui.components import Icon, Row
with Row(gap=4, css_class="items-center"):
Icon("heart", size="sm")
Icon("heart", size="default")
Icon("heart", size="lg")
```
```json Protocol icon="brackets-curly" theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}}
{
"view": {
"cssClass": "gap-4 items-center",
"type": "Row",
"children": [
{"type": "Icon", "name": "heart", "size": "sm"},
{"type": "Icon", "name": "heart", "size": "default"},
{"type": "Icon", "name": "heart", "size": "lg"}
]
}
}
```
## In Context
Icons work inline alongside text and other components.
```python Python icon="python" theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}}
from prefab_ui.components import (
Column,
Icon,
Row,
Text,
)
with Column(gap=3):
with Row(gap=2, css_class="items-center"):
Icon("check", size="sm")
Text("Task completed")
with Row(gap=2, css_class="items-center"):
Icon("clock", size="sm")
Text("Waiting for approval")
with Row(gap=2, css_class="items-center"):
Icon("circle-x", size="sm")
Text("Build failed")
```
```json Protocol icon="brackets-curly" theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}}
{
"view": {
"cssClass": "gap-3",
"type": "Column",
"children": [
{
"cssClass": "gap-2 items-center",
"type": "Row",
"children": [
{"type": "Icon", "name": "check", "size": "sm"},
{"content": "Task completed", "type": "Text"}
]
},
{
"cssClass": "gap-2 items-center",
"type": "Row",
"children": [
{"type": "Icon", "name": "clock", "size": "sm"},
{"content": "Waiting for approval", "type": "Text"}
]
},
{
"cssClass": "gap-2 items-center",
"type": "Row",
"children": [
{"type": "Icon", "name": "circle-x", "size": "sm"},
{"content": "Build failed", "type": "Text"}
]
}
]
}
}
```
## API Reference
Lucide icon name in kebab-case (e.g., `"arrow-right"`, `"circle-alert"`). Can be passed as a positional argument. Browse icons at [lucide.dev/icons](https://lucide.dev/icons).
Icon size: `"sm"`, `"default"`, `"lg"`.
Additional Tailwind CSS classes.
## Protocol Reference
```json Icon theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}}
{
"type": "Icon",
"id?": "string",
"onMount?": "any",
"name": "string (required)",
"size?": "sm | default | lg",
"cssClass?": "string"
}
```
For the complete protocol schema, see [Icon](/protocol/icon).