Man pages sections > man3 > CGI::Toggle

CGI::Toggle -- Utility methods for collapsible sections

CGI::Toggle(3pm) User Contributed Perl Documentation CGI::Toggle(3pm)

NAME

CGI::Toggle -- Utility methods for collapsible sections

SYNOPSIS

use CGI ':standard'; use CGI::Toggle
print header(),
start_html('Toggle Test'),
h1("Toggle Test"),
toggle_section({on=>1},p('This section is on by default'),
toggle_section({on=>0},p('This section is off by default'),
toggle_section({plus_img=>'/icons/open.png',
minus_img=>'/icons/close.png'},
p('This section has custom open and close icons.')),
hr,
end_html;

DESCRIPTION

This package adds JavaScript-based support for collapsible sections by adding a single new function toggle_section().
It overrides the CGI start_html() method, so CGI must be imported before bringing this module in.

METHODS

($control,$content) = toggle_section([\%options],$section_title=>@section_content)
This method takes an optional \%options hashref, a section title and one or more strings containing the section content and returns a list of HTML fragments corresponding to the control link and the content. In a scalar context the control and content will be concatenated together.
 
The option keys are as follows:
b<on>
If true, the section will be on (visible) by default. The default is false (collapsed).
b<plus_img>
URL of the icon to display next to the section title when the section is collapsed. The default is /gbrowse2/images/plus.png.
b<minus_img>
URL of the icon to display next to the section title when the section is expanded.. The default is /gbrowse2/images/minus.png.
b<override>
If false (default), the state of the section will be remembered in a session variable. If true, the initial state will be taken from the b<on> option, ignoring the session.

SEE ALSO

CGI

AUTHOR

Lincoln Stein <lstein@cshl.org>.
Copyright (c) 2005 Cold Spring Harbor Laboratory
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See DISCLAIMER.txt for disclaimers of warranty.
2014-07-10 perl v5.18.2