Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tgstation/tgui-core
React component library and tools for TGUI.
https://github.com/tgstation/tgui-core
react ss13 typescript
Last synced: about 1 month ago
JSON representation
React component library and tools for TGUI.
- Host: GitHub
- URL: https://github.com/tgstation/tgui-core
- Owner: tgstation
- License: mit
- Created: 2024-06-12T01:16:15.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-15T08:07:57.000Z (about 1 month ago)
- Last Synced: 2024-11-15T08:27:02.313Z (about 1 month ago)
- Topics: react, ss13, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/tgui-core
- Size: 750 KB
- Stars: 7
- Watchers: 6
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
README
# tgui-core
A collection of utilities and components for the [tgui](https://github.com/tgstation/tgstation) 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.
You can view the code on [GitHub](https://github.com/tgstation/tgui-core).
## Installation
(assuming you have a tgui folder, navigate to the specific package)
```sh
cd tgui/packages/tgui
yarn add tgui-core
```
## Usage
Now, you can use them like normal TGUI components.
```tsx
import { Button } from "tgui-core/components";
Click;
```
You can even use it in tandem with your own in house TGUI components,
```tsx
import { Button } from "tgui-core/components";
import { Box } from "../components";
```
## License
MIT
## Contributing
Contributions are welcome. Please open an issue or a pull request. I am available on the tgstation [discord](https://discord.com/invite/EUvpBtU78X).
### Releasing a new version
To automagically release a new version of the tgui-core package, simply create a [new release](https://github.com/tgstation/tgui-core/releases/new) 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, generating a release changelog, and publishing to npm.
### Development
This project uses [pnpm](https://pnpm.io/installation) for its package manager.
To set up the repository:
`pnpm install`