render

function render(element, opts?): AppHandle;

Mount a React element into the terminal and start the render loop.

This is the entry point for every Glyph application. It sets up the terminal (raw mode, alternate screen), creates the React reconciler, and begins painting frames.

Parameters

Parameter	Type	Description
element	ReactElement	Root React element to render.
opts	RenderOptions	Optional configuration (custom streams, debug mode, cursor).

Returns

AppHandle

An AppHandle with unmount() and exit() methods.

Example

import { render, Box, Text } from "@semos-labs/glyph";

function App() {
  return (
    <Box style={{ padding: 1 }}>
      <Text style={{ bold: true, color: "cyan" }}>Hello Glyph!</Text>
    </Box>
  );
}

render(<App />);

---

RenderOptions

Options for the top-level render function.

Properties

Property	Type	Description
debug?	boolean	-
stdin?	ReadStream	-
stdout?	WriteStream	-
useNativeCursor?	boolean	Use the terminal’s native cursor instead of a simulated one. Enables cursor shaders/animations in supported terminals. Default: true

---

AppHandle

Handle returned by render, used to control the application lifecycle.

Methods

exit()

exit(code?): void;

Exit the process with an optional exit code.

Parameters

Parameter	Type
code?	number

Returns

void

---

unmount()

unmount(): void;

Tear down the React tree and clean up terminal state.

Returns

void