Docs

Getting Started

Learn how to use Uplink to build frontend-agnostic logic you can reuse across frameworks.

ReactVueSvelteVanilla JS

What is Uplink?

Framework Agnostic

Write your logic once and use it with any UI framework. No need to reimplement the same functionality across different projects.

Reactive State

Built with a reactive core that automatically updates your UI when the underlying state changes, regardless of your framework.

Installation

Install the core package and a logic controller. Here's an example using the Form Controller:

npm
1npm install @uplink-protocol/core @uplink-protocol/form-controller

Then install the integration package for your framework:

npm
1# React
2npm install @uplink-protocol/react
3
4# Vue
5npm install @uplink-protocol/vue
6
7# Svelte
8npm install @uplink-protocol/svelte

Framework Integrations

Uplink works with any UI framework or even vanilla JavaScript. Choose your preferred approach below.

Connect a controller to your React component using useUplinkController():

react
1import { useUplinkController } from "@uplink/react"
2import { FormController } from "@uplink/form"
3
4function MyForm() {
5 const { bindings, methods, state } = useUplinkController(FormController)
6
7 return (
8 <div className="form">
9 <input
10 type="text"
11 value={bindings.values.name}
12 onChange={(e) => methods.setValue("name", e.target.value)}
13 />
14 <button onClick={methods.submit}>Submit</button>
15 <button onClick={methods.reset}>Reset Form</button>
16 </div>
17 )
18}

Ready to Explore?

Form Controller Logic

Explore the Form Controller and learn how to implement a complete form solution with validation.

Coming Soon

More controllers are on the way! Stay tuned for dropdown menus, modals, toasts and more.