tgui-core

tgui-core

A collection of utilities and components for the tgui framework.

This package was built to help the various downstream SS13 servers stay up to date with TGUI without having to keep a local version of each file.

Testing / Demos

This project uses Storybook both for testing locally (via bun storybook) and our live demo site (https://tgstation.github.io/tgui-core/).

Storybook is a sandbox environment for UI components so you can test them in isolation without needing to boot the game.

Links

• GitHub
• npm
• Storybook

Usage

(assuming you have a tgui folder, navigate to the specific package)

cd tgui/packages/{package name}
yarn add tgui-core

Using the components

Now, you can use them like normal TGUI components.

import { Button } from "tgui-core/components";

<Button>Click</Button>;

You can even use it in tandem with your own in house TGUI components,

import { Button } from "tgui-core/components";
import { Box } from "../components";

Using the styles

You have two options for importing styles:

1. Importing All Styles

To import all styles at once, add the following line to your main Sass file:

@use "~tgui-core/styles";

2. Importing Individual Styles

To import individual styles, add any of the exported styles to your main Sass file:

@use "~tgui-core/styles/components/Button";
@use "~tgui-core/styles/components/Dialog";
@use "~tgui-core/styles/components/NoticeBox";

License

MIT

Contributing

Contributions are welcome. Please open an issue or a pull request. I am available on the tgstation discord.

Releasing a new version

To automagically release a new version of the tgui-core package, simply create a new release with the tag set to the new version you want to publish. Set the tag to be the commit you want to base the version off of (likely the latest, being the default).

The release workflow will take care of setting the package.json version, building, and publishing to npm.

Development

This project uses bun for its package manager.

To set up the repository: bun install

To test your changes using Storybook run: bun storybook

To run unit tests run bun test

To build dist folder bun run build-rslib