/ 
Mojolicious-Plugin-Inertia-0.01
River stage zero No dependents
/ README.md

Actions Status MetaCPAN Release

NAME

Mojolicious::Plugin::Inertia - Inertia.js adapter for Mojolicious

SYNOPSIS

# Mojolicious
$app->plugin('Inertia' => {
  version => '1.0.0',  # Asset version for cache busting
  layout  => '<div id="app" data-page="<%= $data_page %>"></div>'
});

# Mojolicious::Lite
plugin 'Inertia' => {
  version => md5_sum($app->home->child('public/assets/manifest.json')->slurp),
  layout  => app->home->child('dist', 'index.html')
};

# In your controller
sub index {
  my $c = shift;

  # Render Inertia page with props
  $c->inertia('Home', {
    user => { name => 'John Doe' },
    posts => \@posts
  });
}

# With lazy evaluation
sub dashboard {
  my $c = shift;

  $c->inertia('Dashboard', {
    # Regular prop
    user => $c->current_user,

    # Lazy prop - only evaluated when needed
    stats => sub {
      return $c->calculate_expensive_stats;
    }
  });
}

DESCRIPTION

Mojolicious::Plugin::Inertia is a Mojolicious plugin that provides server-side adapter for Inertia.js, allowing you to build single-page applications without building an API.

Inertia.js lets you quickly build modern single-page React, Vue and Svelte apps using classic server-side routing and controllers. It works by intercepting requests and converting the responses to either full page loads or JSON with just the page component name and props.

Features

OPTIONS

Mojolicious::Plugin::Inertia supports the following options.

version

plugin 'Inertia' => {version => '1.0.0'};

Required. Asset version string used for cache busting. When the version changes, Inertia will force a full page reload to ensure users get the latest assets.

Common approaches:

# Static version
version => '1.0.0'

# MD5 hash of manifest file
version => md5_sum($app->home->child('manifest.json')->slurp)

layout

plugin 'Inertia' => {layout => 'layouts/inertia.html.ep'};

Required. HTML template or template name containing the root element for your JavaScript application. Must include a <%= $data_page %> placeholder where the page data will be inserted.

Example template:

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>My App</title>
  </head>
  <body>
    <div id="app" data-page='<%= $data_page %>'></div>
    <script src="/js/app.js"></script>
  </body>
</html>

encrypt_history

plugin 'Inertia' => {encrypt_history => 1};

Optional. Enable history encryption by default (defaults to 0). When enabled, page data in the browser's history state will be encrypted.

clear_history

plugin 'Inertia' => {clear_history => 1};

Optional. Clear history on navigate by default (defaults to 0). When enabled, the browser's history state will be cleared on each navigation.

HELPERS

Mojolicious::Plugin::Inertia implements the following helpers.

inertia

$c->inertia($component, \%props, \%options);

Render an Inertia response. Returns either a JSON response for Inertia requests or a full HTML page for standard requests.

Arguments

Options

Examples

# Basic usage
$c->inertia('Home', { message => 'Welcome!' });

# With nested components
$c->inertia('Users/Show', {
  user => $user,
  permissions => \@permissions
});

# With lazy props
$c->inertia('Dashboard', {
  user => $c->current_user,

  # This will only be evaluated if needed (e.g., partial reload)
  stats => sub {
    my $c = shift;  # Controller is passed to the sub
    return $c->db->calculate_stats;
  }
});

# With options
$c->inertia('SecurePage', $props, {
  encrypt_history => 1,
  clear_history => 1
});

Request Headers

Response Headers

Response Codes

SEE ALSO

LICENSE

Copyright (C) kobaken.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

kobaken kentafly88@gmail.com