vue-lynx

Vue 3 custom renderer for building Lynx apps.

Warning

Pre-Alpha — Expect bugs and enjoy!

Documentation

Visit vue.lynxjs.org for full documentation, including:

• Introduction
• Quick Start

Examples

See the examples/ directory. All examples can be run with:

cd examples/<name>
pnpm install
pnpm dev

Tutorials

• gallery — Photo gallery (tutorial)
• swiper — Swiper component (tutorial)

Vue Features

• hello-world — Minimal starter
• basic — Core features (events, refs, reactivity)
• reactivity — reactive(), toRefs(), and composables
• option-api — Options API
• v-model — v-model binding
• slots — Slots and scoped slots
• provide-inject — provide() / inject()
• suspense — Suspense and async components
• transition — <Transition> and <TransitionGroup>
• css-features — CSS selectors and features
• main-thread — Main thread script
• networking — Network requests and data fetching

Ecosystem

• vue-router — Vue Router integration
• pinia — Pinia state management
• tailwindcss — Tailwind CSS styling

Benchmarks

• todomvc — TodoMVC
• 7guis — 7GUIs benchmark tasks
• hackernews-tailwind — HackerNews

Contributing

git clone https://github.com/Huxpro/vue-lynx.git
cd vue-lynx
pnpm install
pnpm build

Scripts

Command	Description
pnpm build	Build all packages (internal, runtime, main-thread, plugin)
pnpm dev	Watch mode for runtime, main-thread, and plugin
pnpm test	Run tests (testing-library)
pnpm test:upstream	Run upstream Vue compatibility tests
pnpm test:dev-smoke	Run dev smoke tests
pnpm lint	Lint with Biome

License

Apache-2.0