1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
# Frequently asked question, common issues, tips and tricks
## Monitor id does not match compositor
The monitor property that windows expect is mapped by Gdk, which is not always
the same as the compositor. Instead use the `gdkmonitor` property which expects
a `Gdk.Monitor` object which you can get from compositor libraries.
Example with Hyprland
```tsx
import Hyprland from "gi://AstalHyprland"
function Bar(gdkmonitor) {
return <window gdkmonitor={gdkmonitor} />
}
function main() {
for (const m of Hyprland.get_default().get_monitors()) {
Bar(m.gdk_monitor)
}
}
App.start({ main })
```
## Environment variables
JavaScript is **not** an bash.
```ts
const HOME = exec("echo $HOME") // does not work
```
`exec` and `execAsync` runs the passed program as is, its **not** run in a
shell environment, so the above example just passes `$HOME` as a string literal
to the `echo` program.
:::danger Please don't do this
You could pass it to bash, but that is a horrible approach.
```ts
const HOME = exec("bash -c 'echo $HOME'")
```
:::
You can read environment variables with [GLib.getenv](https://gjs-docs.gnome.org/glib20~2.0/glib.getenv).
```ts
import GLib from "gi://GLib"
const HOME = GLib.getenv("HOME")
```
## Custom svg symbolic icons
Put the svgs in a directory, named `<icon-name>-symbolic.svg`
and use `App.add_icons` or `icons` parameter in `App.start`
:::code-group
```ts [app.ts]
App.start({
icons: `${SRC}/icons`,
main() {
Widget.Icon({
icon: "custom-symbolic", // custom-symbolic.svg
css: "color: green;", // can be colored, like other named icons
})
},
})
```
:::
:::info
If there is a name clash with an icon from your current icon pack
the icon pack will take precedence
:::
## Logging
The `console` API in gjs uses glib logging functions.
If you just want to print some text as is to stdout
use the globally available `print` function or `printerr` for stderr.
```ts
print("print this line to stdout")
printerr("print this line to stderr")
```
## Binding custom structures
The `bind` function can take two types of objects.
```ts
interface Subscribable<T = unknown> {
subscribe(callback: (value: T) => void): () => void
get(): T
}
interface Connectable {
connect(signal: string, callback: (...args: any[]) => unknown): number
disconnect(id: number): void
}
```
`Connectable` is for mostly gobjects, while `Subscribable` is for `Variables`
and custom objects.
For example you can compose `Variables` in using a class.
```ts
type MyVariableValue = {
number: number
string: string
}
class MyVariable {
number = Variable(0)
string = Variable("")
get(): MyVariableValue {
return {
number: this.number.get(),
string: this.string.get(),
}
}
subscribe(callback: (v: MyVariableValue) => void) {
const unsub1 = this.number.subscribe((value) => {
callback({ string: value, number: this.number.get() })
})
const unsub2 = this.string.subscribe((value) => {
callback({ number: value, string: this.string.get() })
})
return () => {
unsub1()
unsub2()
}
}
}
```
Then it can be used with `bind`.
```tsx
function MyWidget() {
const myvar = new MyVariableValue()
const label = bind(myvar).as(({ string, number }) => {
return `${string} ${number}`
})
return <label label={label} />
}
```
## Populate the global scope with frequently accessed variables
It might be annoying to always import Gtk only for `Gtk.Align` enums.
:::code-group
```ts [globals.ts]
import Gtk from "gi://Gtk"
declare global {
const START: number
const CENTER: number
const END: number
const FILL: number
}
Object.assign(globalThis, {
START: Gtk.Align.START,
CENTER: Gtk.Align.CENTER,
END: Gtk.Align.END,
FILL: Gtk.Align.FILL,
})
```
:::
:::code-group
```tsx [Bar.tsx]
export default function Bar() {
return <window>
<box halign={START} />
</window>
}
```
:::
:::code-group
```ts [app.ts]
import "./globals"
import Bar from "./Bar"
App.start({
main: Bar
})
```
:::
:::info
It is considered bad practice to populate the global scope, but its your code, not a public library.
:::
|
