CatalystX::Usul::TraitFor::Model::NavigationLinks - Provides navigation links
Describes v0.17.$Rev: 1 $
package YourApp::Model::Navigation; use CatalystX::Usul::Moose; with q(CatalystX::Usul::TraitFor::Model::NavigationLinks);
Each of the methods in this class returns a hash ref. that is used to instantiate an anchor link in the HTML::FormWidgets class
Defines the following attributes:
about_action
A string which defaults to /about. The action in the root controller that displays the application "about" information
/about
company_action
A string which defaults to /company. The action in the root controller that displays the information about the company
/company
feedback_action
A string which defaults to /feedback. The action in the root controller that displays the application feedback email form
/feedback
logout_action
A string which defaults to /logout. The action in the root controller that logs the user out of the application
/logout
link_type
One of; modal, tab, or window. Which type of link should be created if the links $c->stash->{fields}->{ link_id } attribute does not specify. A value of modal uses JavaScript to create a model dialog. A value of tab opens a new tab in browser. A value of window creates a new browser window. Defaults to tab.
modal
tab
window
$c->stash->{fields}->{ link_id }
$anchor_hash_ref = $self->get_about_menu_link;
The link to the "about the application" page
$anchor_hash_ref = $self->get_alternate_skin_link;
The link to select a different skin (theme)
$anchor_hash_ref = $self->get_blank_link;
A blank link the goes nowhere
$anchor_hash_ref = $self->get_close_link;
A link that will close the current tab / window
$anchor_hash_ref = $self->get_company_link;
A link the displays information about the company
$anchor_hash_ref = $self->get_context_help_link;
A link the displays the context sensitive help page
$anchor_hash_ref = $self->get_debug_toggle_link;
A link to toggle the runtime debugging state
$anchor_hash_ref = $self->get_default_skin_link;
A link to select the default skin (theme)
$anchor_hash_ref = $self->get_feedback_menu_link;
A link to display the application feedback email form
$anchor_hash_ref = $self->get_footer_toggle_link;
A link that toggles the footer region on / off
$anchor_hash_ref = $self->get_help_menu_link;
A link to display the help menu
$anchor_hash_ref = $self->get_history_back_link;
A link to go back in the browser history
$anchor_hash_ref = $self->get_logo_link;
Returns a content hash ref that renders as a clickable image anchor. The link returns to the web servers default page
$anchor_hash_ref = $self->get_logout_link;
A link to log the user out of the application
$anchor_hash_ref = $self->get_tools_menu_link;
A link to display the tools menu
None
There are no known incompatibilities in this module
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Larry Wall - For the Perl programming language
Peter Flanigan, <Support at RoxSoft.co.uk>
<Support at RoxSoft.co.uk>
Copyright (c) 2014 Peter Flanigan. All rights reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic
This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
To install CatalystX::Usul, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CatalystX::Usul
CPAN shell
perl -MCPAN -e shell install CatalystX::Usul
For more information on module installation, please visit the detailed CPAN module installation guide.