tgui-core 1.0.16 → 1.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +41 -30
  2. package/license.txt +21 -0
  3. package/package.json +8 -4
package/README.md CHANGED
@@ -1,30 +1,41 @@
1
- # tgui-core
2
-
3
- A collection of utilities and components for the [tgui](https://github.com/tgstation/tgstation) framework.
4
-
5
- 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.
6
-
7
- You can view the code on [GitHub](https://github.com/jlsnow301/tgui-core).
8
-
9
- ## Installation
10
-
11
- ```sh
12
- yarn add tgui-core
13
- ```
14
-
15
- ## Usage
16
-
17
- ```tsx
18
- import { Button } from 'tgui-core/components/Button';
19
- import { render } from 'tgui-core/render';
20
-
21
- <Button>Click</Button>;
22
- ```
23
-
24
- ## License
25
-
26
- MIT
27
-
28
- ## Contributing
29
-
30
- Contributions are welcome. Please open an issue or a pull request. I am available on the tgstation [discord](https://discord.com/invite/EUvpBtU78X).
1
+ # tgui-core
2
+
3
+ A collection of utilities and components for the [tgui](https://github.com/tgstation/tgstation) framework.
4
+
5
+ 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.
6
+
7
+ You can view the code on [GitHub](https://github.com/tgstation/tgui-core).
8
+
9
+ ## Installation
10
+
11
+ (assuming you have a tgui folder, navigate to the specific package)
12
+
13
+ ```sh
14
+ cd tgui/packages/tgui
15
+ yarn add tgui-core
16
+ ```
17
+
18
+ ## Usage
19
+
20
+ Now, you can use them like normal TGUI components.
21
+
22
+ ```tsx
23
+ import { Button } from 'tgui-core/components';
24
+
25
+ <Button>Click</Button>;
26
+ ```
27
+
28
+ You can even use it in tandem with your own in house TGUI components,
29
+
30
+ ```tsx
31
+ import { Button } from 'tgui-core/components';
32
+ import { Box } from '../components';
33
+ ```
34
+
35
+ ## License
36
+
37
+ MIT
38
+
39
+ ## Contributing
40
+
41
+ Contributions are welcome. Please open an issue or a pull request. I am available on the tgstation [discord](https://discord.com/invite/EUvpBtU78X).
package/license.txt ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 TG Station
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tgui-core",
3
- "version": "1.0.16",
3
+ "version": "1.0.18",
4
4
  "description": "TGUI core component library",
5
5
  "keywords": [
6
6
  "TGUI",
@@ -24,21 +24,25 @@
24
24
  "require": "./dist/*.cjs"
25
25
  }
26
26
  },
27
+ "repository": {
28
+ "type": "git",
29
+ "url": "https://github.com/tgstation/tgui-core.git"
30
+ },
27
31
  "author": "jlsnow301",
28
32
  "license": "MIT",
29
33
  "type": "module",
30
34
  "devDependencies": {
31
35
  "@popperjs/core": "^2.11.8",
32
- "@types/node": "^20.12.13",
36
+ "@types/node": "^20.14.2",
33
37
  "@types/react": "^18.3.3",
34
38
  "@types/react-dom": "^18.3.0",
35
39
  "@types/webpack-env": "^1.18.5",
36
40
  "@vitejs/plugin-react-swc": "^3.7.0",
37
41
  "glob": "^10.4.1",
38
42
  "react-popper": "^2.3.0",
39
- "sass": "^1.77.4",
43
+ "sass": "^1.77.5",
40
44
  "typescript": "^5.4.5",
41
- "vite": "^5.2.12",
45
+ "vite": "^5.3.1",
42
46
  "vite-plugin-dts": "^3.9.1",
43
47
  "vite-plugin-lib-inject-css": "^2.1.1",
44
48
  "vite-plugin-sass-dts": "^1.3.22"