{"id":21379381,"url":"https://github.com/tgstation/tgui-core","last_synced_at":"2026-06-12T20:00:37.013Z","repository":{"id":244719814,"uuid":"813907337","full_name":"tgstation/tgui-core","owner":"tgstation","description":"React component library and tools for TGUI.","archived":false,"fork":false,"pushed_at":"2026-05-24T19:00:23.000Z","size":2276,"stargazers_count":10,"open_issues_count":9,"forks_count":28,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-05-24T19:04:55.699Z","etag":null,"topics":["react","ss13","typescript"],"latest_commit_sha":null,"homepage":"https://tgstation.github.io/tgui-core/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tgstation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-06-12T01:16:15.000Z","updated_at":"2026-05-18T16:34:04.000Z","dependencies_parsed_at":"2024-06-17T01:25:18.364Z","dependency_job_id":"9779e254-430f-4d94-811e-67576d60e319","html_url":"https://github.com/tgstation/tgui-core","commit_stats":null,"previous_names":["tgstation/tgui-core"],"tags_count":106,"template":false,"template_full_name":null,"purl":"pkg:github/tgstation/tgui-core","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgstation%2Ftgui-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgstation%2Ftgui-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgstation%2Ftgui-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgstation%2Ftgui-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tgstation","download_url":"https://codeload.github.com/tgstation/tgui-core/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgstation%2Ftgui-core/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34260310,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-12T02:00:06.859Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["react","ss13","typescript"],"created_at":"2024-11-22T10:19:27.504Z","updated_at":"2026-06-12T20:00:36.979Z","avatar_url":"https://github.com/tgstation.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tgui-core\n\n[![npm version](https://img.shields.io/npm/v/tgui-core.svg)](https://www.npmjs.com/package/tgui-core)\n\nA collection of utilities and components for the [tgui](https://github.com/tgstation/tgstation) framework.\n\nThis 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.\n\n## Testing / Demos\n\nThis project uses Storybook both for testing locally (via `bun storybook`) and our live demo site (https://tgstation.github.io/tgui-core/).\n\nStorybook is a sandbox environment for UI components so you can test them in isolation without needing to boot the game.\n\n## Links\n\n- [GitHub](https://github.com/tgstation/tgui-core)\n- [npm](https://www.npmjs.com/package/tgui-core)\n- [Storybook](https://tgstation.github.io/tgui-core/?path=/docs/components-animatednumber--docs)\n\n## Usage\n\n(assuming you have a tgui folder, navigate to the specific package)\n\n```sh\ncd tgui/packages/{package name}\nyarn add tgui-core\n```\n\n## Using the components\n\nNow, you can use them like normal TGUI components.\n\n```tsx\nimport { Button } from \"tgui-core/components\";\n\n\u003cButton\u003eClick\u003c/Button\u003e;\n```\n\nYou can even use it in tandem with your own in house TGUI components,\n\n```tsx\nimport { Button } from \"tgui-core/components\";\nimport { Box } from \"../components\";\n```\n\n## Using the styles\n\nYou have two options for importing styles:\n\n### 1. Importing All Styles\n\nTo import all styles at once, add the following line to your main Sass file:\n\n```scss\n@use \"~tgui-core/styles\";\n```\n\n### 2. Importing Individual Styles\n\nTo import individual styles, add any of the exported styles to your main Sass file:\n\n```scss\n@use \"~tgui-core/styles/components/Button\";\n@use \"~tgui-core/styles/components/Dialog\";\n@use \"~tgui-core/styles/components/NoticeBox\";\n```\n\n## License\n\nMIT\n\n## Contributing\n\nContributions are welcome. Please open an issue or a pull request. I am available on the tgstation [discord](https://discord.com/invite/EUvpBtU78X).\n\n### Releasing a new version\n\nTo 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).\n\nThe release workflow will take care of setting the `package.json` version, building, and publishing to npm.\n\n### Development\n\nThis project uses [bun](https://bun.sh/docs/installation) for its package manager.\n\nTo set up the repository:\n`bun install`\n\nTo test your changes using [Storybook](https://storybook.js.org/docs) run:\n`bun storybook`\n\nTo run unit tests run\n`bun test`\n\nTo build dist folder\n`bun run build-rslib`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftgstation%2Ftgui-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftgstation%2Ftgui-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftgstation%2Ftgui-core/lists"}