@lynx-js/react

ReactLynx

ReactLynx is a framework that allows you to build cross-platform Lynx apps with React paradigm.

• Aligned with React 17+
  Built on battle-tested open-source implementations, it fully supports functional components, Hooks, and Context — the same set of modern React APIs.

• Made for Lynx
  Dual-threaded React tailor-made for Lynx, carrying over Lynx's instant launch and silky UI responsiveness.

• Compatible with React Ecosystem
  With Jotai and Zustand for state management, TanStack Query for data fetching, Fast Refresh and DevTools for React components, everything you need is here.

Content

• Content
• Getting Started
• Documentation
• Community and Support
• Contributing
• License
• Credits

Getting Started

For the quick start guide, please visit Getting Started.

Documentation

You can find the documentation of ReactLynx on ReactLynx website.

You can also find the following specific sections here:

• Getting Started
• Introduction & Guides
• API Reference

For the documentation of Lynx, please visit Lynx.

Community and Support

• GitHub Issues - Report bugs or request features

Contributing

We welcome contributions! Please see our Code of Conduct and Contributing Guide for more details.

License

ReactLynx is Apache License 2.0 licensed.

Credits

Thanks to:

• Preact for creating a lightweight and efficient implementation of React's APIs that served as the foundation for ReactLynx runtime.
• React for creating a gaming-changing UI library and programming model that has inspired a generation of declarative UI technologies.
• Reanimated, React Server Component and Web Worklet for inspiring ReactLynx's dual-threaded programming models such as Main Thread Scripting.
• SWC project created by @kdy1, which turbocharges ReactLynx's code transformation with Rust-powered efficiency, achieving sub-second build times and frictionless developer experience.