@lynx-js/lynx-ui

@lynx-js/lynx-ui is the official headless UI library for ReactLynx, provided as a reference for building flexible, universal, and high-performance ReactLynx components.

Introduction

We extend native components' capabilities through frontend components, toward a high-performance, native-like Lynx component ecosystem with broad compatibility.

UI characteristics on the same platform often differ in behavior, APIs, and even design philosophy, especially for advanced features. Cross-platform frameworks must bridge these gaps, and Lynx is no exception.

This is where lynx-ui comes in, streamlining and unifying disparate atomic APIs to reconcile underlying behaviors and limitations, delivering a consistent experience across platforms.

Installation

lynx-ui supports both full-library imports and individual component imports.

Option 1: Full-Library Import (Recommended)

Import the entire lynx-ui package. Tree-shaking is supported, so unused components won't increase your final build size.

pnpm add @lynx-js/lynx-ui

Usage:

import { Button } from '@lynx-js/lynx-ui'

export default function App() {
  return (
    <view>
      <Button>Hello</Button>
    </view>
  )
}

Option 2: Importing Individual Components

Each lynx-ui component is distributed as a separate package. Use this approach for compatibility or specific requirements.

Example with <Button>:

pnpm add @lynx-js/lynx-ui-button

Usage:

import { Button } from '@lynx-js/lynx-ui-button'

export default function App() {
  return (
    <view>
      <Button>Hello</Button>
    </view>
  )
}

Configuration

If you are using rspeedy, configure the pluginReactLynx as follows:

// lynx.config.ts
import { defineConfig } from '@lynx-js/rspeedy'

export default defineConfig({
  plugins: [
    pluginReactLynx({
      enableNewGesture: true,
    }),
  ],
})

Compatibility

• LynxSDK: >= 3.2

These are full-library requirements. Individual components may have different version requirements.

Development

If you are interested in contributing to lynx-ui, please read our Contributing Guide.

License

lynx-ui is Apache License 2.0 licensed.