NAME
    Text::Table::HTML::DataTables - Generate HTML table with jQuery and
    DataTables plugin

VERSION
    This document describes version 0.011 of Text::Table::HTML::DataTables
    (from Perl distribution Text-Table-HTML-DataTables), released on
    2022-03-22.

SYNOPSIS
     use Text::Table::HTML::DataTables;

     my $rows = [
         # header row
         ['Name', 'Rank', 'Serial'],
         # rows
         ['alice', 'pvt', '123<456>'],
         ['bob',   'cpl', '98765321'],
         ['carol', 'brig gen', '8745'],
     ];
     print Text::Table::HTML::DataTables::table(rows => $rows, header_row => 1);

DESCRIPTION
    This module is just like Text::Table::HTML, except the HTML code will
    also load jQuery (<http://jquery.com>) and the DataTables plugin
    (<http://datatables.net>) from the local filesystem (distribution shared
    directory), so you can filter and sort the table in the browser.

    The datatables bundled in this distribution has the following
    characteristics:

    *   Support negative search using dash prefix syntax ("-foo") a la
        Google

        To search for table rows that contain "foo", "bar" (in no particular
        order) and not "baz", you can enter in the search box:

         foo bar -baz

    The example shown in the SYNOPSIS generates HTML code like the
    following:

     <link rel="stylesheet" type="text/css" href="file:///home/ujang/perl5/perlbrew/perls/perl-5.24.0/lib/site_perl/5.24.0/auto/share/dist/Text-Table-HTML-DataTables/datatables-1.10.13/css/jquery.dataTables.min.css">
     <script src="file:///home/ujang/perl5/perlbrew/perls/perl-5.24.0/lib/site_perl/5.24.0/auto/share/dist/Text-Table-HTML-DataTables/jquery-2.2.4/jquery-2.2.4.min.js"></script>
     <script src="file:///home/ujang/perl5/perlbrew/perls/perl-5.24.0/lib/site_perl/5.24.0/auto/share/dist/Text-Table-HTML-DataTables/datatables-1.10.13/js/jquery.dataTables.min.js"></script>
     <script>$(document).ready(function() { $("table").DataTable(); });</script>

     <table>
     <thead>
     <tr><th>Name</th><th>Rank</th><th>Serial</th></tr>
     </thead>
     <tbody>
     <tr><td>alice</td><td>pvt</td><td>12345</td></tr>
     <tr><td>bob</td><td>cpl</td><td>98765321</td></tr>
     <tr><td>carol</td><td>brig gen</td><td>8745</td></tr>
     </tbody>
     </table>

FUNCTIONS
  table(%params) => str
  OPTIONS
    The "table" function understands these parameters, which are passed as a
    hash:

    *   rows (aoaos)

        Takes an array reference which should contain one or more rows of
        data, where each row is an array reference.

    *   caption

        Optional. Str. If set, will output a HTML "<title>" element in the
        HTML head as well as table "<caption>" element in the HTML body
        containing the provided caption. The caption will be HTML-encoded.

    *   default_length

        Integer, defaults to 1000. Set the default page size.

    *   library_link_mode

        Str, defaults to "local". Instructs how to link or embed the
        JavaScript libraries in the generated HTML page. Valid values
        include: "local" (the HTML will link to the local filesystem copy of
        the libraries, e.g. in the shared distribution directory), "cdn"
        (not yet implemented, the HTML will link to the CDN version of the
        libraries), "embed" (the HTML will embed the libraries directly).

ENVIRONMENT
  PERL_TEXT_TABLE_HTML_DATATABLES_OPT_LIBRARY_LINK_MODE
    String. Used to set the default for the "library_link_mode" option.

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/Text-Table-HTML-DataTables>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-Text-Table-HTML-DataTables>.

SEE ALSO
    Text::Table::HTML

    See also Bencher::Scenario::TextTableModules.

    <https://datatables.net>

AUTHOR
    perlancar <perlancar@cpan.org>

CONTRIBUTING
    To contribute, you can send patches by email/via RT, or send pull
    requests on GitHub.

    Most of the time, you don't need to build the distribution yourself. You
    can simply modify the code, then test via:

     % prove -l

    If you want to build the distribution (e.g. to try to install it locally
    on your system), you can install Dist::Zilla,
    Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two
    other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional
    steps required beyond that are considered a bug and can be reported to
    me.

COPYRIGHT AND LICENSE
    This software is copyright (c) 2022, 2021, 2020, 2016 by perlancar
    <perlancar@cpan.org>.

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

BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=Text-Table-HTML-DataT
    ables>

    When submitting a bug or request, please include a test-file or a patch
    to an existing test-file that illustrates the bug or desired feature.

