/ 
Dancer2-Plugin-Ajax-0.400000
River stage one • 1 direct dependent • 1 total dependent
/ Dancer2::Plugin::Ajax

NAME

Dancer2::Plugin::Ajax - a plugin for adding Ajax route handlers

VERSION

version 0.400000

SYNOPSIS

package MyWebApp;

use Dancer2;
use Dancer2::Plugin::Ajax;

# For GET / POST
ajax '/check_for_update' => sub {
    my $self = shift;

    # ... some Ajax code
};

# For all valid HTTP methods
ajax ['get', 'post', ... ] => '/check_for_more' => sub {
    my $self = shift;

    # ... some Ajax code
};

dance;

DESCRIPTION

The ajax keyword which is exported by this plugin allows you to define a route handler optimized for Ajax queries.

The route handler code will be compiled to behave like the following:

  • Pass if the request header X-Requested-With doesn't equal XMLHttpRequest

  • Disable the layout

  • The action built matches POST / GET requests by default. This can be extended by passing it an ArrayRef of allowed HTTP methods.

The route handler gets the Dancer $self object passed in, just like any other Dancer2 route handler. You can use this to inspect the request data.

ajax '/check_for_update' => sub {
    my $self = shift;
    
    my $method = $self->app->request->method;
    # ...
}

CONFIGURATION

By default the plugin will use a content-type of 'text/xml', but this can be overridden with the plugin setting content_type.

Here is an example to use JSON:

plugins:
  Ajax:
    content_type: 'application/json'

AUTHOR

Dancer Core Developers

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Alexis Sukrieh.

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