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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
Bun supports `.jsx` and `.tsx` files out of the box. Bun's internal transpiler converts JSX syntax into vanilla JavaScript before execution.
```tsx#react.tsx
function Component(props: {message: string}) {
return (
<body>
<h1 style={{color: 'red'}}>{props.message}</h1>
</body>
);
}
console.log(<Component message="Hello world!" />);
```
## Configuration
Bun reads your `tsconfig.json` or `jsconfig.json` configuration files to determines how to perform the JSX transform internally. To avoid using either of these, the following options can also be defined in [`bunfig.toml`](/docs/runtime/configuration).
The following compiler options are respected.
### [`jsx`](https://www.typescriptlang.org/tsconfig#jsx)
How JSX constructs are transformed into vanilla JavaScript internally. The table below lists the possible values of `jsx`, along with their transpilation of the following simple JSX component:
```tsx
<Box width={5}>Hello</Box>
```
{% table %}
- Compiler options
- Transpiled output
---
- ```json
{
"jsx": "react"
}
```
- ```tsx
import { createElement } from "react";
createElement("Box", { width: 5 }, "Hello");
```
---
- ```json
{
"jsx": "react-jsx"
}
```
- ```tsx
import { jsx } from "react/jsx-runtime";
jsx("Box", { width: 5 }, "Hello");
```
---
- ```json
{
"jsx": "react-jsxdev"
}
```
- ```tsx
import { jsxDEV } from "react/jsx-dev-runtime";
jsxDEV(
"Box",
{ width: 5, children: "Hello" },
undefined,
false,
undefined,
this,
);
```
The `jsxDEV` variable name is a convention used by React. The `DEV` suffix is a visible way to indicate that the code is intended for use in development. The development version of React is slower and includes additional validity checks & debugging tools.
---
- ```json
{
"jsx": "preserve"
}
```
- ```tsx
// JSX is not transpiled
// "preserve" is not supported by Bun currently
<Box width={5}>Hello</Box>
```
{% /table %}
<!-- {% table %}
- `react`
- `React.createElement("Box", {width: 5}, "Hello")`
---
- `react-jsx`
- `jsx("Box", {width: 5}, "Hello")`
---
- `react-jsxdev`
- `jsxDEV("Box", {width: 5}, "Hello", void 0, false)`
---
- `preserve`
- `<Box width={5}>Hello</Box>` Left as-is; not yet supported by Bun.
{% /table %} -->
### [`jsxFactory`](https://www.typescriptlang.org/tsconfig#jsxFactory)
{% callout %}
**Note** — Only applicable when `jsx` is `react`.
{% /callout %}
The function name used to represent JSX constructs. Default value is `"createElement"`. This is useful for libraries like [Preact](https://preactjs.com/) that use a different function name (`"h"`).
{% table %}
- Compiler options
- Transpiled output
---
- ```json
{
"jsx": "react",
"jsxFactory": "h"
}
```
- ```tsx
import { h } from "react";
h("Box", { width: 5 }, "Hello");
```
{% /table %}
### [`jsxFragmentFactory`](https://www.typescriptlang.org/tsconfig#jsxFragmentFactory)
{% callout %}
**Note** — Only applicable when `jsx` is `react`.
{% /callout %}
The function name used to represent [JSX fragments](https://react.dev/reference/react/Fragment) such as `<>Hello</>`; only applicable when `jsx` is `react`. Default value is `"Fragment"`.
{% table %}
- Compiler options
- Transpiled output
---
- ```json
{
"jsx": "react",
"jsxFactory": "myjsx",
"jsxFragmentFactory": "MyFragment"
}
```
- ```tsx
// input
<>Hello</>;
// output
import { myjsx, MyFragment } from "react";
createElement("Box", { width: 5 }, "Hello");
```
{% /table %}
### [`jsxImportSource`](https://www.typescriptlang.org/tsconfig#jsxImportSource)
{% callout %}
**Note** — Only applicable when `jsx` is `react-jsx` or `react-jsxdev`.
{% /callout %}
The module from which the component factory function (`createElement`, `jsx`, `jsxDEV`, etc) will be imported. Default value is `"react"`. This will typically be necessary when using a component library like Preact.
{% table %}
- Compiler options
- Transpiled output
---
- ```jsonc
{
"jsx": "react"
// jsxImportSource is not defined
// default to "react"
}
```
- ```tsx
import { jsx } from "react/jsx-runtime";
jsx("Box", { width: 5, children: "Hello" });
```
---
- ```jsonc
{
"jsx": "react-jsx",
"jsxImportSource": "preact"
}
```
- ```tsx
import { jsx } from "preact/jsx-runtime";
jsx("Box", { width: 5, children: "Hello" });
```
---
- ```jsonc
{
"jsx": "react-jsxdev",
"jsxImportSource": "preact"
}
```
- ```tsx
// /jsx-runtime is automatically appended
import { jsxDEV } from "preact/jsx-dev-runtime";
jsxDEV(
"Box",
{ width: 5, children: "Hello" },
undefined,
false,
undefined,
this,
);
```
{% /table %}
### JSX pragma
All of these values can be set on a per-file basis using _pragmas_. A pragma is a special comment that sets a compiler option in a particular file.
{% table %}
- Pragma
- Equivalent config
---
- ```ts
// @jsx h
```
- ```jsonc
{
"jsxFactory": "h"
}
```
---
- ```ts
// @jsxFrag MyFragment
```
- ```jsonc
{
"jsxFragmentFactory": "MyFragment"
}
```
---
- ```ts
// @jsxImportSource preact
```
- ```jsonc
{
"jsxImportSource": "preact"
}
```
{% /table %}
## Logging
Bun implements special logging for JSX to make debugging easier. Given the following file:
```tsx#index.tsx
import { Stack, UserCard } from "./components";
console.log(
<Stack>
<UserCard name="Dom" bio="Street racer and Corona lover" />
<UserCard name="Jakob" bio="Super spy and Dom's secret brother" />
</Stack>
);
```
Bun will pretty-print the component tree when logged:
{% image src="https://github.com/oven-sh/bun/assets/3084745/d29db51d-6837-44e2-b8be-84fc1b9e9d97" / %}
## Prop punning
The Bun runtime also supports "prop punning" for JSX. This is a shorthand syntax useful for assigning a variable to a prop with the same name.
```tsx
function Div(props: {className: string;}) {
const {className} = props;
// without punning
return <div className={className} />;
// with punning
return <div {className} />;
}
```
|
