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
215
216
217
218
219
220
221
222
223
224
225
226
227
|
# Widget
## AGS widget properties
These are properties that Astal.js additionally adds to Gtk.Widgets
- className: `string` - List of class CSS selectors separated by white space.
- css: `string` - Inline CSS. e.g `label { color: white; }`. If no selector is specified `*` will be assumed. e.g `color: white;` will be inferred as `* { color: white; }`.
- cursor: `string` - Cursor style when hovering over widgets that have hover states, e.g it won't work on labels. [list of valid values](https://docs.gtk.org/gdk3/ctor.Cursor.new_from_name.html).
- clickThrough: `boolean` - Lets click events through.
To have a full list of available properties, reference the documentation of the widget.
- [Astal widgets](https://aylur.github.io/libastal/index.html#classes)
- [Gtk widgets](https://docs.gtk.org/gtk3/#classes)
## AGS widget methods
Additional methods that Astal.js adds to Gtk.Widget instances
### setup
`setup` is a convenience prop to not have predefine widgets before returning them
without `setup`
```tsx
function MyWidget() {
const button = Widget.Button()
// setup button
return button
}
```
using `setup`
```tsx
function MyWidget() {
function setup(button: Widget.Button) {
// setup button
}
return <buttons setup={setup} />
}
```
### hook
Shorthand for connection and disconnecting to gobjects.
without `hook`
```tsx
function MyWidget() {
const id = gobject.connect("signal", callback)
return <box
onDestroy={() => {
gobject.disconnect(id)
}}
/>
}
```
with `hook`
```tsx
function MyWidget() {
return <box
setup={(self) => {
self.hook(gobject, "signal", callback)
}}
/>
}
```
### toggleClassName
Toggle classNames based on a condition
```tsx
function MyWidget() {
return <box
setup={(self) => {
self.toggleClassName("classname", someCondition)
}}
/>
}
```
## How to use non builtin Gtk widgets
Using `Widget.astalify` you can setup widget constructors to behave like builtin widgets.
The `astalify` function will apply the following:
- set `visible` to true by default (Gtk3 widgets are invisible by default)
- make gobject properties accept and consume `Binding` objects
- add properties and methods listed above
- proxify the constructor so the `new` keyword is not needed
- sets up signal handlers that are passed as props prefixed with `on`
```tsx
import { Widget, Gtk } from "astal"
// define its props, constructor and type
export type ColorButtonProps = Widget.ConstructProps<
Gtk.ColorButton,
Gtk.ColorButton.ConstructorProps,
{ onColorSet: [] }
>
export const ColorButton = Widget.astalify<
typeof Gtk.ColorButton,
ColorButtonProps,
"ColorButton"
>(Gtk.ColorButton)
export type ColorButton = ReturnType<typeof ColorButton>
function MyWidget() {
function setup(button: ColorButton) {}
return <ColorButton
setup={setup}
useAlpha
rgba={new Gdk.RGBA({
red: 1,
green: 0,
blue: 0,
alpha: 0.5,
})}
onColorSet={(self) => {
console.log(self.rgba)
}}
/>
}
```
:::info
Signal properties have to be annotated manually for TypeScript.
You can reference [Gtk3](https://gjs-docs.gnome.org/gtk30~3.0/)
and [Astal](https://aylur.github.io/libastal/index.html#classes) for available signals.
:::
:::tip
As stated before children are passed as either `child` or `children` property,
when passing a container widget with `Widget.astalify` these rules still apply.
While subclasses of `Gtk.Bin` *can* take a `child` property in gjs, you might notice
a warning that it is deprecated. You can workaround this with a simple wrapper function.
```tsx
const GtkFrame = Widget.astalify<
typeof Gtk.Frame,
FrameProps,
"Frame"
>(Gtk.Frame)
export function Frame({ child, ...props }: FrameProps) {
const frame = GtkFrame(props)
frame.add(child) // use the widget's child adding function
return frame
}
```
:::
## TypeScript
Type of widgets are available through `Widget`.
Here is an example Widget that takes in and handles a possibly `Binding` prop.
```tsx
import { Binding, Variable, Widget } from "astal"
export interface ToggleButtonProps extends Widget.ButtonProps {
onToggled?: (self: Widget.Button, on: boolean) => void
state?: Binding<boolean> | boolean
child?: JSX.Element
}
export default function ToggleButton(btnprops: ToggleButtonProps) {
const { state = false, onToggled, setup, child, ...props } = btnprops
const innerState = Variable(state instanceof Binding ? state.get() : state)
return <button
{...props}
setup={self => {
setup?.(self)
self.toggleClassName("active", innerState.get())
self.hook(innerState, () => self.toggleClassName("active", innerState.get()))
if (state instanceof Binding) {
self.hook(state, () => innerState.set(state.get()))
}
}}
onClicked={self => {
onToggled?.(self, !innerState.get())
}}
>
{child}
</button>
}
```
## Builtin Widgets
You can check the [source code](https://github.com/aylur/astal/blob/main/core/gjs/src/widgets.ts) to have a full list of builtin widgets.
These widgets are available by default in JSX.
- box: [Astal.Box](https://aylur.github.io/libastal/class.Box.html)
- button: [Astal.Button](https://aylur.github.io/libastal/class.Button.html)
- centerbox: [Astal.CenterBox](https://aylur.github.io/libastal/class.CenterBox.html)
- circularprogress: [Astal.CircularProgress](https://aylur.github.io/libastal/class.CircularProgress.html)
- drawingarea: [Gtk.DrawingArea](https://docs.gtk.org/gtk3/class.DrawingArea.html)
- entry: [Gtk.Entry](https://docs.gtk.org/gtk3/class.Entry.html)
- eventbox: [Astal.EventBox](https://aylur.github.io/libastal/class.EventBox.html)
- icon: [Astal.Icon](https://aylur.github.io/libastal/class.Icon.html)
- label: [Astal.Label](https://aylur.github.io/libastal/class.Label.html)
- levelbar: [Astal.LevelBar](https://aylur.github.io/libastal/class.LevelBar.html)
- overlay: [Astal.Overlay](https://aylur.github.io/libastal/class.Overlay.html)
- revealer: [Gtk.Revealer](https://docs.gtk.org/gtk3/class.Revealer.html)
- scrollable: [Astal.Scrollable](https://aylur.github.io/libastal/class.Scrollable.html)
- slider: [Astal.Slider](https://aylur.github.io/libastal/class.Slider.html)
- stack: [Astal.Stack](https://aylur.github.io/libastal/class.Stack.html)
- switch: [Gtk.Switch](https://docs.gtk.org/gtk3/class.Switch.html)
- window: [Astal.Window](https://aylur.github.io/libastal/class.Window.html)
|
