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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
package schema
type KeywordDef struct {
Name string
Description string
Syntax string
Documentation string
}
var (
kwTempl = &KeywordDef{
Name: "templ",
Description: "Define a reusable TUI component",
Syntax: "templ Name(params) { ... }",
Documentation: `## templ
Defines a reusable TUI component. Supports two forms:
### Function Component
` + "```gsx" + `
templ Name(param1 Type1, param2 Type2) {
<div>...</div>
}
` + "```" + `
Compiles to a Go function returning ` + "`*tui.Element`" + `.
### Method Component (Struct)
` + "```gsx" + `
templ (s *MyStruct) Render() {
<div>...</div>
}
` + "```" + `
Used with Go struct types that implement ` + "`tui.Component`" + `.
The struct, constructor, and methods are defined as regular Go code
in the same .gsx file:
` + "```gsx" + `
type sidebar struct {
expanded *tui.State[bool]
}
func Sidebar() *sidebar {
return &sidebar{expanded: tui.NewState(true)}
}
func (s *sidebar) KeyMap() tui.KeyMap {
return tui.KeyMap{...}
}
templ (s *sidebar) Render() {
<div>...</div>
}
` + "```" + `
### Children Slot
Components can accept children using ` + "`{children...}`" + `:
` + "```gsx" + `
templ Card(title string) {
<div class="border-rounded p-1">
<span>{title}</span>
{children...}
</div>
}
` + "```" + `
Callers pass children with a block:
` + "```gsx" + `
@Card("Title") {
<span>Content</span>
}
` + "```" + `
### Children in Struct Components
Struct components can also accept children by adding a ` + "`children []*tui.Element`" + ` field:
` + "```gsx" + `
type card struct {
title string
children []*tui.Element
}
func NewCard(title string, children []*tui.Element) *card {
return &card{title: title, children: children}
}
templ (c *card) Render() {
<div class="border-rounded p-1">
<span>{c.title}</span>
{children...}
</div>
}
` + "```",
}
kwFor = &KeywordDef{
Name: "for",
Description: "Loop over items",
Syntax: "for index, item := range collection { ... }",
Documentation: `## for
Iterates over a collection, rendering elements for each item.
**Syntax:**
` + "```gsx" + `
for index, item := range collection {
<element>...</element>
}
` + "```" + `
**Example:**
` + "```gsx" + `
for i, name := range names {
<li>{fmt.Sprintf("%d. %s", i+1, name)}</li>
}
` + "```" + `
- Supports standard Go range syntax
- Variables are scoped to the loop body
- Can iterate over slices, arrays, maps, and channels`,
}
kwIf = &KeywordDef{
Name: "if",
Description: "Conditional rendering",
Syntax: "if condition { ... } else { ... }",
Documentation: `## if
Conditionally renders elements based on a boolean expression.
**Syntax:**
` + "```gsx" + `
if condition {
<element>...</element>
} else {
<element>...</element>
}
` + "```" + `
**Example:**
` + "```gsx" + `
if user.IsAdmin {
<span class="text-green">Admin</span>
} else {
<span class="text-dim">User</span>
}
` + "```" + `
- Condition must be a Go boolean expression
- else clause is optional`,
}
kwElse = &KeywordDef{
Name: "else",
Description: "Else branch of conditional",
Syntax: "} else { ... }",
Documentation: `## else
The else branch of a conditional if statement.
**Syntax:**
` + "```gsx" + `
if condition {
<element>...</element>
} else {
<element>...</element>
}
` + "```" + `
- Must follow an if block
- Contains elements to render when condition is false`,
}
kwPackage = &KeywordDef{
Name: "package",
Description: "Go package declaration",
Syntax: "package mypackage",
Documentation: `## package
Declares the Go package for the generated code.
**Syntax:**
` + "```gsx" + `
package mypackage
` + "```" + `
- Must be the first declaration in the file
- Generated Go code will have this package name
- Should match the directory name (Go convention)`,
}
kwImport = &KeywordDef{
Name: "import",
Description: "Import Go packages",
Syntax: "import ( ... )",
Documentation: `## import
Imports Go packages for use in expressions.
**Syntax:**
` + "```gsx" + `
import (
"fmt"
"strings"
"mymodule/pkg/utils"
)
` + "```" + `
- Standard Go import syntax
- Imported packages can be used in {} expressions
- The tui package is automatically available`,
}
kwFunc = &KeywordDef{
Name: "func",
Description: "Define a helper function or method",
Syntax: "func name(params) returnType { ... }",
Documentation: `## func
Defines a Go function or method at the file level. Unlike ` + "`templ`" + `,
these are plain Go code compiled as-is into the generated file.
### Helper Function
` + "```gsx" + `
func formatLabel(s string) string {
return fmt.Sprintf("[%s]", s)
}
` + "```" + `
### Method (for struct components)
` + "```gsx" + `
func (s *sidebar) KeyMap() tui.KeyMap {
return tui.KeyMap{
tui.On(tui.Rune('b').Ctrl(), s.toggle),
}
}
` + "```" + `
- Regular Go function and method syntax
- Cannot contain GSX element literals
- Methods are used with struct components for ` + "`KeyMap()`" + `, ` + "`Init()`" + `, callbacks, etc.
- Compiled as-is into the generated Go file`,
}
)
var Keywords = map[string]*KeywordDef{
"templ": kwTempl,
"for": kwFor,
"if": kwIf,
"else": kwElse,
"package": kwPackage,
"import": kwImport,
"func": kwFunc,
}
func GetKeyword(name string) *KeywordDef {
return Keywords[name]
}
|