Skip to main content

Using Nebula Icons in Other Libraries

Let's say you're using Nebula Icons for your own projects in roblox, or another UI Library.
This part of the guide will show you how to format the returned icon to work.

For the first example, we shall be

Using Nebula Icons in Rayfield​

Rayfield accepts the asset Id of the image we are using. This is the same as Starlight, meaning we can simply set the value to the method. 

local Tab = Window:CreateTab('Rayfield Tab', NebulaIcons:GetIcon("view_in_ar", "Material"))

However, not all libraries work like this. Some libraries like Cascade and Compkiller have their properties merged with the full instance. Meaning, that they work the same as a Roblox Image property. And the next guide will come in handy.

Using Nebula Icons in Roblox​

The Image parameter takes a rbxassetid:// or Roblox HTTP Image value.

  • rbxassetid://123456789
  • http://www.roblox.com/asset/?id=123456789

The GetIcon method returns the number part, so we can use set the value to combined string of the prefix and the id. 

-- Cascade Library
local symbol = row:Right():Symbol({
    Image = "rbxassetid://" .. tostring(NebulaIcons:GetIcon("acorn", "Phosphor-Filled")),
})

Using Nebula Icons in Other Cases​

Of course, not every single library works this way. Some may have completely different ways of parsing images.
However, just know how to bend the Library to work with them, as they all will contain the asset id or use it somewhere.
Key Takeaways:

  • Use ... to merge strings with variables.
  • GetIcon will return the asset id number (to be merged with whatever systems).