Skip to content

Icon entry

IconEntry is icon-forward: the value itself is treated as an icon name, or you pass .icon(...) / .boolean() for check / x display. Use it when the show page should lead with a glyph — status pictogram, feature flag, presence — instead of a text string.

Shared Entry chrome (label, helper, placeholder, tooltip) still applies — labels stack above the icon by default.

State is a Heroicon name string.

app/orbit/resources/post_resource.py
from almasix.orbit.infolists import IconEntry
IconEntry.make("icon").label("Icon").color("primary").size("lg")

Orbit Icon entry basic (light)

Orbit Icon entry basic (dark)

.boolean() maps truthy → .true_icon() (default heroicon-o-check) and falsy → .false_icon() (default heroicon-o-x-mark). Colors default to success / danger; override with .true_color() / .false_color(), or a shared .color(...).

app/orbit/resources/post_resource.py
IconEntry.make("active").label("Active").boolean()
IconEntry.make("featured")
.label("Featured")
.boolean()
.false_color("gray")
.false_icon("heroicon-o-minus")

Orbit Icon entry boolean (light)

Orbit Icon entry boolean (dark)

.color(...) tints the icon. .size("sm" | "md" | "lg" | …) maps to or-icon-size-*.

app/orbit/resources/post_resource.py
IconEntry.make("icon").label("Launch").color("warning").size("md")

Orbit Icon entry colors (light)

Orbit Icon entry colors (dark)

Method Notes
.boolean True / false icon mode
.true_icon / .false_icon Override boolean glyphs
.true_color / .false_color Per-state colors
.color Shared icon color
.size Icon size utility
.icon Explicit icon when state is not a name
.placeholder Empty-state text (non-boolean)