An abstract type that represents a JSX.element

Render a JSX.element as a string.

This function takes a JSX.element and converts it into its corresponding HTML string representation.

  let html: string = JSX.render(
    <div>
      <h1> {JSX.string("Hello, World!")} </h1>
    </div>
  );

  Printf.printf "%s" html; /* <div><h1>Hello, World!</h1></div> */

Helper to render a float.

This function helps in rendering a float value as a JSX element.

  let element : JSX.element = JSX.float 3.14

• deprecated Use JSX.list instead

Helper to render an integer.

This function helps in rendering an integer value as a JSX element.

  let element : JSX.element = JSX.int 42

Helper to render a list of elements.

This function takes a list of JSX elements and returns a single JSX element that contains all of them. This is useful for rendering dynamic lists of elements.

  let element : JSX.element =
    JSX.list
      [ JSX.string "Item 1"; JSX.string "Item 2"; JSX.string "Item 3" ]

Represents an attribute of an HTML element. It consists of a name and a value which can be of several types.

This is used by the ppx to create the attributes of the HTML element, and rarely used directly.

The function to create an HTML DOM Node.

It takes a tag name, a list of attributes, and a list of child elements to create an HTML node.

  let link : JSX.element =
    JSX.node
      ( "a",
        [ ("href", `String "https://ocaml.org") ],
        [ JSX.string "OCaml" ] )

Helper to represent nullability in JSX.

This is useful to represent and pattern match against null or empty elements.

  let element : JSX.element = JSX.null

Helper to represent an element as a string.

This function allows you to directly render a string as a JSX element.

  let element : JSX.element = JSX.string "Hello, World!"

A deprecated function to render a text string.

This function is deprecated in favor of JSX.string.

  let element : JSX.element = JSX.text "Hello, World!"

• deprecated Use JSX.string instead

Helper to bypass HTML encoding and treat output as unsafe. This can lead to HTML escaping problems, XSS injections, and other security concerns. Use with caution.

A common use case for bypassing the HTML encoding is to render a script o style tag.

  let content: string = "Raw HTML" in
  let script: JSX.element = <script> content </script>

Escape a string for safe HTML output. This escapes ampersand, less-than, greater-than, apostrophe, and double-quote characters. Returns the original string if no escaping is needed (fast path).

This is used internally by the PPX for optimized rendering when dynamic string content is known at compile time to be a string (not a JSX.element).

  JSX.escape "<script>" (* Returns "&lt;script&gt;" *) JSX.escape
    "hello" (* Returns "hello" - no allocation *)

Write an element directly to a buffer. This is used internally by the PPX for optimized rendering when building HTML strings incrementally.

  let buf = Buffer.create 256 in
  JSX.write buf (JSX.string "Hello");
  Buffer.contents buf (* "Hello" *)