https://github.com/ollipal/userust

Custom Rust WebAssembly hooks for React and SolidJS projects
https://github.com/ollipal/userust

react rust solidjs typrescript wasm wasm-bindgen

Last synced: about 1 month ago
JSON representation

Custom Rust WebAssembly hooks for React and SolidJS projects

• Host: GitHub
• URL: https://github.com/ollipal/userust
• Owner: ollipal
• License: mit
• Created: 2023-01-14T09:16:44.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-29T12:27:37.000Z (over 1 year ago)
• Last Synced: 2024-09-29T13:23:09.076Z (about 2 months ago)
• Topics: react, rust, solidjs, typrescript, wasm, wasm-bindgen
• Language: TypeScript
• Homepage:
• Size: 577 KB
• Stars: 7
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# useRust

Add custom Rust WebAssembly hooks to React and SolidJS projects

```rust

// my-rust-code/src/lib.rs

#[wasm_bindgen]

pub fn add(a: i32, b: i32) -> i32 {

    a + b

}

```

```js

import useRust from 'my-rust-code'

const Calculator = () => {

  const { rust, error } = useRust()

  return 
1+1={rust?.add(1,1)}

}

```


## How it works

1. Have an existing React or SolidJS project

2. `npx userust init NAME` will compile and install a custom useRust hook to your project

3. Use it in your project: `import useRust from 'NAME'` 

4. Make changes to `./NAME/src/lib.rs`

5. `npm run NAME:build` will recompile the useRust hook

Alternatively you can use `npm run NAME:watch` to automatically recompile after changes to Rust code

Uses [wasm-bindgen](https://rustwasm.github.io/wasm-bindgen/). See Rust code examples at its [documentation page](https://rustwasm.github.io/wasm-bindgen/).

## Features

- Leverage Rust and Wasm to speed up critical parts of your frontend

- Fully typed TypeScript interface, works in JavaScript projects as well

- No limitations for Rust code, provides a minimal, properly configured boilerplate to start with

- Develop frontend and Rust code from the same monorepo with a few simple commands

- Tested on Linux, MacOS and Windows

- npm, pnpm and yarn supported

- Simple interface inspired by [SWR](https://swr.vercel.app/) library

[Full documentation](DOCUMENTATION.md)

## Licence 

The MIT License.