The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Mojolicious-Plugin-Loco-0.001
River stage zero No dependents
2 ++
/ Mojolicious::Plugin::Loco

NAME

Mojolicious::Plugin::Loco - launch local GUI via default web browser

VERSION

version 0.001

SYNOPSIS

  # myapp.pl

  use Mojolicious::Lite
  plugin 'Loco';

  get '/' => "index";
  #...
  app->start;

  __DATA__
  @@ index.html.ep
  % layout 'default';
  %# ... main page

  @@ layouts/default.html.ep
  <!DOCTYPE html><html><head>
  %= $c->loco->jsload;
  %= content_for 'head'
  </head><body>
  %= content
  </body>
  </html>

DESCRIPTION

This plugin allows writing low-effort desktop applications using Mojolicious (even cross-platform ones if your code is sufficiently portable).

When run as a daemon listening on an explicit loopback/localhost port, the plugin causes a dedicated window to open in your default internet browser, assuming we're in a desktop/window-manager context where Browser::Open is meaningful. The server will then shut down once the browser window and all descendants thereof are subsequently closed.

OPTIONS

initial_wait

How many seconds to wait on server start for browser window to finish loading. Defaults to 10.

final_wait

How many seconds to wait after browser window ceases communicating before terminating (we do not rely on window.unload). Defaults to 3.

Since javascript timer events from backgrounded/hidden tabs/windows are typically throttled, reducing this below 2 will most likely make the application terminate whenever the window is hidden or minimized.

entry

URI path for the entry point of your application (i.e., what to display when the brower window opens). Defaults to /.

api_path

Path prefix for URIs used by this plugin. This is where the various endpoints needed by this module live (and is also where the required javascript file(s) are served from). Defaults to /hb/; it can be pretty much anything as long as it's distinct from what the rest of your application uses. But it would be best to keep it short.

HELPERS

loco.jsload

Loads whatever javascript needs to be in the <head> section of every page to be displayed in the browser window. You most likely want this in your default layout.

  %= $c->loco->jsload;

Or you can be more elaborate

  %= javascript 'https://code.jquery.com/jquery-3.3.1.min.js';
  %= $c->loco->jsload( nojquery => 1, begin
        .on_hb(function(h) {
          // do something on every heartbeat
          $('#heartbeat').html(h);
        })
  % end );

Options include

nojquery

Suppress loading of jquery from the Mojolicious distribution, meaning you already loaded it from elsewhere (needs to be at least version 3.0).

nofinish

Suppress the default on_finish handler.

begin

Final begin block, if provided, will be assumed to be javascript code to further configure the heartbeat object (code is preceded by $().heartbeat()), typically to add on_hb or on_finish handlers

METHODS

Mojolicious::Plugin::Loco inherits all methods from Mojolicious::Plugin and implements the following new ones.

register

  $plugin->register(Mojolicious->new, entry => '/');

Register plugin in Mojolicious application.

SEE ALSO

Mojolicious, Mojolicious::Guides, https://mojolicious.org.

AUTHOR

Roger Crew <wrog@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by Roger Crew.

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