├── .editorconfig
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── build.ts
├── bun.lockb
├── docs
├── build-app.md
├── jsx.md
└── typescript.md
├── package.json
├── src
├── fetch.ts
├── gobject.ts
├── gtk4
│ ├── buttons.tsx
│ ├── common.ts
│ ├── containers.tsx
│ ├── displays.tsx
│ ├── entries.tsx
│ ├── index.ts
│ └── windows.tsx
├── index.ts
├── jsx-runtime.ts
├── reactive.ts
├── storage.ts
├── store.ts
├── web-ponyfill.ts
└── widget.tsx
├── tsconfig.json
└── typedoc.json
/.editorconfig:
--------------------------------------------------------------------------------
1 | # EditorConfig is awesome: https://EditorConfig.org
2 |
3 | # top-most EditorConfig file
4 | root = true
5 |
6 | [*]
7 | indent_style = space
8 | indent_size = 4
9 | end_of_line = lf
10 | charset = utf-8
11 | trim_trailing_whitespace = false
12 | insert_final_newline = false
13 |
14 | [*.ts,*.js,*.tsx,*.jsx]
15 | indent_size = 2
--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
1 | *.lockb binary diff=lockb
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | dist/
2 | types/
3 | docs-dist/
4 | node_modules
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright [yyyy] [name of copyright owner]
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
203 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # GSolid
2 |
3 | Simple and performant reactivity for building user interfaces, with GTK 4. GSolid is a universal GTK renderer for [solid-js](https://www.solidjs.com).
4 |
5 | - Performant: Working with native `Gtk.Widget` without heavy middleware. No Tick, No Late.
6 | - Powerful: Composable reactive primitives plus the flexibility of JSX.
7 | - Productive: Ergonomics and familiarity that make building simple or complex frontends a breeze.
8 |
9 | GSolid supports [Gjs](https://gitlab.gnome.org/GNOME/gjs/).
10 |
11 | Launch your project in seconds with [gsolid-app-starter](https://github.com/thislight/gsolid-app-starter)!
12 |
13 | ```jsx
14 | import Gtk from "gi://Gtk?version=4.0";
15 | import { createSignal } from "gsolid";
16 | import { Box, Button, Label, ReactiveWindow, createApp } from "gsolid/gtk4";
17 |
18 | createApp((app) => {
19 | const [counter, setCounter] = createSignal(0);
20 | app.add_window(
21 | false}
24 | title="Hello World!"
25 | defaultWidth={300}
26 | defaultHeight={250}
27 | >
28 |
29 |
30 |
37 | as Gtk.Window);
38 | }, { application_id: "org.example.MyApp" }).run(null);
39 |
40 | ```
41 |
42 | ## Bundling
43 |
44 | - [esbuild-plugin-gsolid](https://github.com/thislight/esbuild-plugin-gsolid)
45 |
46 | Interesting on writing bundler for GSolid? See [Notes on build Applications](./docs/build-app.md).
47 |
48 | ## Other Documents
49 |
50 | - [JSX](./docs/jsx.md)
51 | - [TypeScript](./docs/typescript.md)
52 |
53 | ## Special Libraries
54 |
55 | GSolid provides some libraries to improve UX for gjs.
56 |
57 | Mostly we create the library similiar to the Web API, but they are not 1:1 simulation to the API on the other platform.
58 |
59 | - `gsolid/fetch` - Fetch API, libsoup 3.x wrapper
60 |
61 | ## License
62 |
63 | SPDX: Apache-2.0
64 |
--------------------------------------------------------------------------------
/build.ts:
--------------------------------------------------------------------------------
1 | import * as esbuild from "esbuild";
2 |
3 | const entryPoints = [
4 | "src/index.ts",
5 | "src/jsx-runtime.ts",
6 | "src/gtk4/common.ts",
7 | "src/gtk4/index.ts",
8 | "src/fetch.ts",
9 | "src/web-ponyfill.ts",
10 | "src/reactive.ts",
11 | "src/store.ts",
12 | "src/storage.ts",
13 | "src/gobject.ts",
14 | ];
15 |
16 | const gtk4JsxEntryPoints = [
17 | "buttons.tsx",
18 | "containers.tsx",
19 | "displays.tsx",
20 | "entries.tsx",
21 | "windows.tsx",
22 | ].map((x) => `src/gtk4/${x}`);
23 |
24 | await Promise.all([
25 | esbuild.build({
26 | entryPoints,
27 | outdir: "dist",
28 | format: "esm",
29 | jsx: "preserve",
30 | }),
31 | esbuild.build({
32 | entryPoints,
33 | outdir: "dist",
34 | format: "cjs",
35 | jsx: "preserve",
36 | outExtension: {
37 | ".js": ".cjs",
38 | },
39 | }),
40 | esbuild.build({
41 | entryPoints: ["src/widget.tsx"],
42 | outdir: "dist",
43 | format: "esm",
44 | jsx: "preserve",
45 | outExtension: {
46 | ".js": ".jsx",
47 | },
48 | }),
49 | esbuild.build({
50 | entryPoints: gtk4JsxEntryPoints,
51 | outdir: "dist/gtk4",
52 | format: "esm",
53 | jsx: "preserve",
54 | outExtension: {
55 | ".js": ".jsx",
56 | },
57 | }),
58 | ]);
59 |
--------------------------------------------------------------------------------
/bun.lockb:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/thislight/gsolid/83dac1a6dee9759429b1f8adef5dcb64006123c3/bun.lockb
--------------------------------------------------------------------------------
/docs/build-app.md:
--------------------------------------------------------------------------------
1 | # Notes to build Applications
2 |
3 | This document is for the bundler developers and describes some requirements to correctly bundle gsolid application.
4 |
5 | You can also check out the [esbuild-plugin-gsolid](https://github.com/thislight/esbuild-plugin-gsolid).
6 |
7 | ## Translate JSX files using [babel-preset-solid](https://github.com/solidjs/solid/tree/main/packages/babel-preset-solid)
8 |
9 | Sample babel config:
10 |
11 | ```js
12 | presets: [
13 | [
14 | "babel-preset-solid",
15 | {
16 | moduleName: "gsolid/jsx-runtime",
17 | generate: "universal",
18 | },
19 | ],
20 | ],
21 | ```
22 |
23 | The preset does not support TSX files, so they must be translated to JSXs before feeding babel-preset-solid.
24 |
25 | ## Inject `gsolid/web-ponyfill`
26 |
27 | `gsolid/web-ponyfill` is a ESM ponyfill. Every export must be imported in `solid-js`'s files. For example, such content will be injected into the start of the every files:
28 |
29 | ````js
30 | import {queueMicrotask} from "gsolid/web-ponyfill"
31 | ````
32 |
33 | Since the `solid-js` does not have dependency to `gsolid`, the bundler must resolve the `gsolid/web-ponyfill` to a nearest package.
34 |
35 | Currently, copying the file content into the files works. The file SHOULD be no side effect.
36 |
37 |
--------------------------------------------------------------------------------
/docs/jsx.md:
--------------------------------------------------------------------------------
1 | # JSX
2 |
3 | JSX is the core of GSolid.
4 |
5 | ## The burned line of two worlds
6 |
7 | GSolid operates on JavaScript functions and GTK widgets.
8 |
9 | In GSolid, you create "components". They are JavaScript functions, must be run under reactive context, returns widgets. By saying "widget", we say the GTK widgets.
10 |
11 | You can instantly use widgets as components by function `useWidget` or component `Widget` from `gsolid/widget`. You can also wrap any component into a widget by creating a new GTK `Widget` class (with reactive context).
12 |
13 | An important note is that you can use the JSX syntax anywhere and the result is a widget. For example:
14 |
15 | ```jsx
16 | import {Window, Label} from "gsolid/gtk4"
17 |
18 | const showHelloWorld = () => {
19 | const window =
20 | window.set_child(