Skip to content

Crest

Crest adds Roblox topbar-style icon buttons that follow TopbarInset. Chain fluent setters, bind events, and drive notice badges. Client chrome only — shop logic stays on the server / Flare.

Header: #include <clpp/libs/crest.clh>. Runtime: CluauppLibs.Crest.

Use when:

  • Settings, shop, or inventory entry from the top bar with correct inset on console/mobile.
  • Toggle panels bound with bindToggleItem and select / deselect.

Do not use when:

  • You need in-world billboards — Pin.
  • You need reactive HUD layout — Gleam.
#include <clpp/libs/crest.clh>
void OpenShop() {
post("open shop");
}
[[client]]
void init() {
Crest shop = new Crest();
shop.setName("Shop");
shop.setLabel("Shop");
shop.setRight();
shop.bindEvent("selected", OpenShop);
}

Returns: Crest icon controller.

When: Each topbar button is its own instance (not a separate Icon type).

Crest icon = new Crest();

Returns: Crest (chainable).

When: Stable instance name under the Crest ScreenGui.

Returns: Crest.

When: Text drawn on the icon when no image is set.

Returns: Crest.

When: rbxassetid or asset URI for the button face.

Returns: Crest.

When: Hide or disable interaction without destroying.

Returns: Crest.

When: LayoutOrder among icons in the same alignment bucket.

Returns: Crest.

When: Non-square icon width (height stays icon size).

Returns: Crest.

When: "left", "mid" / "center", or "right" bucket under Crest host.

Returns: Crestalign("left").

When: Default left cluster.

Returns: Crest — center cluster.

When: Single prominent action.

Returns: Crest — right cluster.

When: Shop / settings on the right (common pattern).

Returns: Crest.

When: Listen for runtime events such as "selected", "deselected", "Activated", "toggled", "notified", hover events.

icon.bindEvent("selected", func () { /* ... */ });

Returns: Crest.

When: A GuiObject panel shown while this icon is selected.

Returns: Crest — shows notice dot.

When: Unread mail or pending reward indicator.

Returns: Crest — hides notice dot.

When: Player opened the related panel.

Returns: Crest — marks selected, shows bound toggle items, may deselect other auto-deselect icons.

When: Programmatic open state.

Returns: Crest.

When: Close bound panel without destroying icon.

Returns: void.

When: Remove icon and disconnect from layout.