Package Exports

@heliad/topbarplus
@heliad/topbarplus/out/init.lua

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@heliad/topbarplus) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@rbxts/topbar-plus

TypeScript bindings for TopbarPlus 3.4 — a Roblox topbar icon library by ForeverHD.

Installation

npm install @rbxts/topbar-plus

Usage

import { Icon } from "@rbxts/topbar-plus";

const icon = new Icon();
icon.setLabel("Players")
    .align("Right")
    .setCaption("Scoreboard")
    .bindToggleKey(Enum.KeyCode.Tab)
    .bindEvent("toggled", (self, isSelected) => {
        print(`Toggled: ${isSelected}`);
    });

What's included

The full TopbarPlus 3.4.0 Lua source under out/icon/
A thin wrapper at out/init.lua that exposes { Icon } for import { Icon } ergonomics
TypeScript types in out/index.d.ts ported from the upstream Types.lua, with strongly-typed bindEvent callbacks per event name

License

Mozilla Public License 2.0. See LICENSE. By using TopbarPlus you also agree to either keep the in-game Attribute UI unchanged, or credit TopbarPlus in your experience description.

Credits

TopbarPlus is created and maintained by ForeverHD. This package only re-distributes the upstream Lua source with TypeScript type definitions added.