Dancer::Plugin::Device::Layout::Example - Sample real life web application.
This example should help you understand how Dancer::Plugin::Device::Layout works and how you can integrate the plugin in your existing Dancer web application.
You have created a realy cool web application which looks great on desktop computers (big screens) but is nearly unreadable on mobile devices such as smartphones or tablets because of its small display size? This is where Dancer::Plugin::Device::Layout can help you with.
Dancer::Plugin::Device::Layout provides a subroutine that detects the remote device on the base of the user agent of every web request. This subroutine returns in a array/hash context the Dancer/template option key value pair for the layout.
With Dancer::Plugin::Device::Layout default settings Dancer::Plugin::Device::Layout/device_layout is assigning the layout 'tablet' to tablet devices, 'mobile' to smartphones and 'normal' to all other devices. So you need theese three layouts within 'views/layouts'.
The layouts can help you easily setup device (mostly screen size) optimized looks for your web application.
MyApp is the web application used for this example.
You need to load the plugin first ofcourse.
package MyApp; use Dancer ':syntax'; use Dancer::Plugin::Device::Layout; our $VERSION = '0.1'; get '/' => sub { template 'index'; } true;
You need to update every Dancer/template call.
package MyApp; use Dancer ':syntax'; use Dancer::Plugin::Device::Layout; our $VERSION = '0.1'; get '/' => sub { my $tokens = {}; my $options = { device_layout }; template 'index', $tokens, $options; } true;
config.yml
Now you can modify the defaults of Dancer::Plugin::Device::Layout by update your config.yml.
# This is the main configuration file of your Dancer app # env-related settings should go to environments/$env.yml # all the settings in this file will be loaded at Dancer's startup. # Your application's name appname: "MyApp" # The default layout to use for your application (located in # views/layouts/main.tt) layout: "main" # when the charset is set to UTF-8 Dancer will handle for you # all the magic of encoding and decoding. You should not care # about unicode within your app when this setting is set (recommended). charset: "UTF-8" # template engine # simple: default and very basic template engine # template_toolkit: TT template: "simple" # template: "template_toolkit" # engines: # template_toolkit: # start_tag: '[%' # end_tag: '%]' # Here comes the Dancer::Plugin::Device::Layout configuration. plugins: Device::Layout: normal_layout: normal mobile_layout: mobile tablet_layout: tablet no_tablet: 0 tablet_as_mobile: 0 no_mobile: 0
Now you are done with integrate Dancer::Plugin::Device::Layout in your Dancer web application.
4 POD Errors
The following errors were encountered while parsing the POD:
alternative text 'Dancer/template' contains non-escaped | or /
alternative text 'Dancer::Plugin::Device::Layout/device_layout' contains non-escaped | or /
To install Dancer::Plugin::Device::Layout, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dancer::Plugin::Device::Layout
CPAN shell
perl -MCPAN -e shell install Dancer::Plugin::Device::Layout
For more information on module installation, please visit the detailed CPAN module installation guide.