.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Dancer2::Plugin::Ajax 3pm"
.TH Dancer2::Plugin::Ajax 3pm "2021-01-08" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Dancer2::Plugin::Ajax \- a plugin for adding Ajax route handlers
.SH "VERSION"
.IX Header "VERSION"
version 0.400000
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package MyWebApp;
\&
\&    use Dancer2;
\&    use Dancer2::Plugin::Ajax;
\&
\&    # For GET / POST
\&    ajax \*(Aq/check_for_update\*(Aq => sub {
\&        my $self = shift;
\&
\&        # ... some Ajax code
\&    };
\&
\&    # For all valid HTTP methods
\&    ajax [\*(Aqget\*(Aq, \*(Aqpost\*(Aq, ... ] => \*(Aq/check_for_more\*(Aq => sub {
\&        my $self = shift;
\&
\&        # ... some Ajax code
\&    };
\&
\&    dance;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`ajax\*(C'\fR keyword which is exported by this plugin allows you to define a route
handler optimized for Ajax queries.
.PP
The route handler code will be compiled to behave like the following:
.IP "\(bu" 4
Pass if the request header X\-Requested-With doesn't equal XMLHttpRequest
.IP "\(bu" 4
Disable the layout
.IP "\(bu" 4
The action built matches \s-1POST / GET\s0 requests by default. This can be extended by passing it an ArrayRef of allowed \s-1HTTP\s0 methods.
.PP
The route handler gets the Dancer \f(CW$self\fR object passed in, just like any other Dancer2 route handler.
You can use this to inspect the request data.
.PP
.Vb 2
\&    ajax \*(Aq/check_for_update\*(Aq => sub {
\&        my $self = shift;
\&        
\&        my $method = $self\->app\->request\->method;
\&        # ...
\&    }
.Ve
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
By default the plugin will use a content-type of 'text/xml', but this can be overridden
with the plugin setting \f(CW\*(C`content_type\*(C'\fR.
.PP
Here is an example to use \s-1JSON:\s0
.PP
.Vb 3
\&  plugins:
\&    Ajax:
\&      content_type: \*(Aqapplication/json\*(Aq
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Dancer Core Developers
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by Alexis Sukrieh.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.