widget documentation

1 files changed, 75 insertions, 0 deletions

diff --git a/lib/Reaction/UI/Widget/Action/Link.pm b/lib/Reaction/UI/Widget/Action/Link.pm
index 1063ed0..0c40670 100644
--- a/lib/Reaction/UI/Widget/Action/Link.pm
+++ b/lib/Reaction/UI/Widget/Action/Link.pm
@@ -18,3 +18,78 @@ __PACKAGE__->meta->make_immutable;
 
 __END__;
 
+=head1 NAME
+
+Reaction::UI::Widget::Action::Link - A hyperlink representing an object mutation
+
+=head1 DESCRIPTION
+
+=head1 FRAGMENTS
+
+=head2 widget
+
+The following additional arguments are provided:
+
+=over 4
+
+=item uri
+
+The viewport's C<uri>.
+
+=item label
+
+The localised value of the viewport's C<label>.
+
+=back
+
+=head1 LAYOUT SETS
+
+=head2 base
+
+  share/skin/base/layout/action/link.tt
+
+The following layouts are provided:
+
+=over 4
+
+=item widget
+
+Renders a hyperlink with a C<href> attribute set to the C<uri> argument and
+the content set to the C<label> argument.
+
+=back
+
+=head2 default
+
+  share/skin/default/layout/action/link.tt
+
+This layout set extends the C<NEXT> layout set with the same name in the parent
+skin.
+
+The following layouts are provided:
+
+=over 4
+
+=item widget
+
+Renders a C<br> element after the original C<widget> fragment.
+
+=back
+
+=head1 SEE ALSO
+
+=over 4
+
+=item * L<Reaction::UI::Widget::Action>
+
+=back
+
+=head1 AUTHORS
+
+See L<Reaction::Class> for authors.
+
+=head1 LICENSE
+
+See L<Reaction::Class> for the license.
+
+=cut