Documentation

Nexus UI is a UI framework for FiveM resources. You write components in .nexus files and declare every message between the page and Lua once. What you get is a page that costs nothing while it is closed, and a server that only ever sees input it has already validated.

npm create nexus-ui my_shop
cd my_shop
npm install
npm run dev

npm run dev opens the UI in a browser, with a mock in place of the game. It needs Node.js 20 or newer, and the resource needs lua54 'yes'.

Start

Guide From nexus create to a working screen, step by step. About fifteen minutes, and it touches every part of the framework.

Reference

The .nexus format Script, template and styles, every directive and block, and the screen tag.

The bridge The contract, the Lua API, the security model and the wire format.

Command line create, dev, build and check, and the layout of a resource.

Playground Edit a component in the browser and watch it run.

Project

Roadmap What this version does not do.

Changelog What changed in each release.

The source, the example resource and the issue tracker are on GitHub.