For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /api/index.md.
This is the dev preview website. Check out the document at lynx-stack.dev

Home

API Reference

Packages

Package

Description

@lynx-js/chunk-loading-webpack-plugin

An Rspack plugin to generate chunk loading runtime for Lynx.

@lynx-js/config-rsbuild-plugin

An rsbuild plugin for config Lynx Config defined by @lynx-js/type-config.

@lynx-js/css-extract-webpack-plugin

This plugin extracts CSS into separate files. It creates a CSS file per JS file which contains CSS and CSSId.

@lynx-js/external-bundle-rsbuild-plugin

@lynx-js/externals-loading-webpack-plugin

A webpack plugin to load externals in Lynx. Use lynx.fetchBundle() and lynx.loadScript() API to load and parse the externals.

@lynx-js/lynx-bundle-rslib-config

@lynx-js/lynx-bundle-rslib-config is the package that provides the configurations for bundling Lynx bundle with Rslib.

@lynx-js/qrcode-rsbuild-plugin

A rsbuild plugin that print the Lynx bundle url using QRCode.

@lynx-js/react

@lynx-js/react is React for Lynx. It keeps the React 17 API surface, re-exporting the standard hooks and APIs, and adds what the dual-thread model needs: main-thread functions, the data a page receives from native, and a few compile-time directives and macros.

@lynx-js/react-refresh-webpack-plugin

A rspack plugin to integrate prefresh with ReactLynx.

@lynx-js/react-rsbuild-plugin

A rsbuild plugin that integrates with ReactLynx.

@lynx-js/react-webpack-plugin

A webpack plugin to integrate webpack with ReactLynx.

@lynx-js/rspeedy

The document contains all the configurations of the @lynx-js/rspeedy package.

@lynx-js/runtime-wrapper-webpack-plugin

A webpack plugin that adds runtime wrapper to allow JavaScript to be load by Lynx.

@lynx-js/template-webpack-plugin

A webpack plugin that simplifies creation of Lynx bundle (.bundle) files to serve your bundles.

@lynx-js/type-config

@lynx-js/webpack-runtime-globals

A packages for all the runtime requirements that Lynx uses.