Bun supports .jsx
and .tsx
files out of the box. Bun's internal transpiler converts JSX syntax into vanilla JavaScript before execution.
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
.
The following compiler options are respected.
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:
<Box width={5}>Hello</Box>
Compiler options | Transpiled output |
---|---|
|
|
|
|
|
The |
|
|
jsxFactory
Note — Only applicable when jsx
is react
.
The function name used to represent JSX constructs. Default value is "createElement"
. This is useful for libraries like Preact that use a different function name ("h"
).
Compiler options | Transpiled output |
---|---|
|
|
jsxFragmentFactory
Note — Only applicable when jsx
is react
.
The function name used to represent JSX fragments such as <>Hello</>
; only applicable when jsx
is react
. Default value is "Fragment"
.
Compiler options | Transpiled output |
---|---|
|
|
jsxImportSource
Note — Only applicable when jsx
is react-jsx
or react-jsxdev
.
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.
Compiler options | Transpiled output |
---|---|
|
|
|
|
|
|
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.
Pragma | Equivalent config |
---|---|
|
|
|
|
|
|
Logging
Bun implements special logging for JSX to make debugging easier. Given the following file:
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:
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.
function Div(props: {className: string;}) {
const {className} = props;
// without punning
return <div className={className} />;
// with punning
return <div {className} />;
}