I urge you to follow this topic, why? This is to know when a new update is available.
Docs
Documentation / API Reference - Github
What is UIShelf?
UIShelf is a module. This module creates custom topbar icons on the “top shelf” of your screen. With lots of easy to use functions
Screenshots & Videos
Should I use this over Topbar Plus v2?
Obviously this is going to be your decision, but here are some pros and cons of UIShelf:
Pros:
-
Button selection is the same exact thing as buttons in
CoreGui
, as TopbarPlus shows a gradient when selected. -
It’s a bit easier to understand; less complicated features.
-
If you have script auto-complete enabled, you can view the functions and make the process of creating a button faster, in TopbarPlus the functions are not displayed in the auto-complete menu. (more of a UX thing)
-
The notifications are realistic to the
CoreGui
buttons. -
Instead of just using assetId’s, you can use other image paths, for example:
example:SetImage("rbxasset://textures/ui/SearchIcon.png")
Cons:
- Less features, and I am willing to admit it
- You can’t have dropdowns
- You can’t create labels on buttons
Example Script:
local UIShelf = require(script.Parent:WaitForChild("MainModule"))
local NewButton = UIShelf.new()
NewButton:setImage("rbxasset://textures/ui/SearchIcon.png")
NewButton:setLeft()
NewButton:setOrder(2)
NewButton:setName("SearchIcon")
NewButton:bindIconEvent("MouseClick", function()
print(string.format("%s was clicked!", NewButton:returnName()))
end)
Think you want to use it in your project? No credit to me required!
Take the script for completely free:
I am open to any constructive criticism
I will ignore anyone who asks about a question already answered in this post.
Thanks.
Quick Poll(s)
Take these poll(s) to see how I can improve this!
- I am going to use it
- I would use it, but I will not
- I am not going to use this
- This is terrible
0 voters
- 1/10
- 2/10
- 3/10
- 4/10
- 5/10
- 6/10
- 7/10
- 8/10
- 9/10
- 10/10
0 voters
Canary Product Feedback Form
Legacy Updates
REINSTALL AFTER UPDATES:
3/4/22:
Added ChatDisabledOffset
property, now icons should work with chat disabled.
3/14/22:
Fixed StateOverlay
from being too large.
4/10/22:
Fixed StateOverlay
from being too small.
Added MouseButton1Up
function to the module to easily detect when pressed.
4/16/22:
Added tons of new functions
Fixed formatting issues
Updated all scripts to be more efficient
4/26/22:
Added tons of new functions
4/28/22:
Added the notification feature.
Find functions in API reference.
4/29/22:
Fixed up the code to prevent it from failing.
Changed a few function names.
Each button is more organized and efficient.
Removed ChatDisabledOffset
in the module, ChatDisabledOffset
is now auto set. Use the function ToggleChatDisabledOffset
to get this enabled. (kind of)
5/12/22:
Added new function type, State
functions.
Added more folders for better organization
Gave the model a thumbnail
GitHub Repo: GitHub - canaryprojects/module-library: Modules
Big thanks to @ForeverHD
Thank you for inspiring me to make this module.
Obviously if you don’t want to use my resource (i bet you won’t) then go checkout TopbarPlus v2