https://github.com/stuarth/inertia-rs

Inertia.js for Rust
https://github.com/stuarth/inertia-rs

inertiajs rocket rust

Last synced: 29 days ago
JSON representation

Inertia.js for Rust

• Host: GitHub
• URL: https://github.com/stuarth/inertia-rs
• Owner: stuarth
• Created: 2021-08-04T13:18:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-21T16:54:25.000Z (12 months ago)
• Last Synced: 2024-09-26T20:45:42.452Z (about 1 month ago)
• Topics: inertiajs, rocket, rust
• Language: Rust
• Homepage:
• Size: 29.3 KB
• Stars: 34
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-inertiajs - Rust

README

        
# Inertia.rs

[![Current Crates.io Version](https://img.shields.io/crates/v/inertia-rs)](https://crates.io/crates/inertia_rs)

[![Build Status](https://github.com/stuarth/inertia-rs/workflows/CI/badge.svg)](https://github.com/stuarth/inertia-rs/actions)

[![docs.rs](https://img.shields.io/badge/docs-latest-blue.svg?style=flat)](https://docs.rs/inertia_rs/)

[Inertia.js](https://inertiajs.com/) implementations for Rust. Currently supports [Rocket](https://rocket.rs/).

## Why Inertia?

From [inertiajs.com](https://inertiajs.com/)

> Inertia is a new approach to building classic server-driven web apps. We call it the modern monolith.

>

> Inertia allows you to create fully client-side rendered, single-page apps, without much of the complexity that comes with modern SPAs. It does this by leveraging existing server-side frameworks.

>

> Inertia has no client-side routing, nor does it require an API. Simply build controllers and page views like you've always done!

Inertia.rs brings a straightforward integration to Rust.

## Installation

Add the following line to your `Cargo.toml`

```toml

inertia_rs = { version = "0.2.0", features = ["rocket"] }

```

## Usage

`inertia_rs` defines a succinct interface for creating Inertia.js apps in Rocket. It's comprised of two elements, 

* **`Inertia`**

  

  a [Responder](https://api.rocket.rs/v0.5-rc/rocket/response/trait.Responder.html) that's generic over `T`, the Inertia component's properties

  

* **`VersionFairing`**

   

   Responsible for asset version checks. Constructed via `VersionFairing::new`, which is given the asset version and a closure responsible for generating the Inertia's HTML template.

### Sample Rocket Server

```rust

#[macro_use]

extern crate rocket;

use inertia_rs::rocket::{Inertia, VersionFairing};

use rocket::response::Responder;

use rocket_dyn_templates::Template;

#[derive(serde::Serialize)]

struct Hello {

    some_property: String,

}

#[get("/hello")]

fn hello() -> Inertia {

    Inertia::response(

        // the component to render

        "hello",

        // the props to pass our component

        Hello { some_property: "hello world!".into() },

    )

}

#[launch]

fn rocket() -> _ {

    rocket::build()

        .mount("/", routes![hello])

        .attach(Template::fairing())

        // Version fairing is configured with current asset version, and a 

        // closure to generate the html template response

        // `ctx` contains `data_page`, a json-serialized string of 

        // the inertia props

        .attach(VersionFairing::new("1", |request, ctx| {

            Template::render("app", ctx).respond_to(request)

        }))

}

```