widget documentation

[catagits/Reaction.git] / lib / Reaction / UI / Widget / Field / Mutable / MatchingPasswords.pm

diff --git a/lib/Reaction/UI/Widget/Field/Mutable/MatchingPasswords.pm b/lib/Reaction/UI/Widget/Field/Mutable/MatchingPasswords.pm
index 5668510..544b11a 100644 (file)
--- a/lib/Reaction/UI/Widget/Field/Mutable/MatchingPasswords.pm
+++ b/lib/Reaction/UI/Widget/Field/Mutable/MatchingPasswords.pm
@@ -23,3 +23,51 @@ __PACKAGE__->meta->make_immutable;
 1;
 
 __END__;
+
+=head1 NAME
+
+Reaction::UI::Widget::Field::Mutable::MatchingPasswords - Require double input of password
+
+=head1 DESCRIPTION
+
+This is a subclass of L<Reaction::UI::Widget::Field::Mutable::Password> implementing
+a second field to repeat the password input.
+
+=head1 FRAGMENTS
+
+=head2 widget
+
+Will render the C<check_field> fragment after the original C<widget> fragment.
+
+=head2 check_field
+
+Renders C<field> with C<field_id> and C<field_name> set to the viewport's C<check_value> event.
+
+=head2 check_label
+
+Localises the C<label> argument with a value from the viewport's C<check_label> attribute if
+one is specified and renders the C<label> fragment.
+
+=head1 LAYOUT SETS
+
+=head2 base
+
+  share/skin/base/layout/field/mutable/matching_passwords.tt
+
+=head1 SEE ALSO
+
+=over 4
+
+=item * L<Reaction::UI::Widget::Field::Mutable::Password>
+
+=back
+
+=head1 AUTHORS
+
+See L<Reaction::Class> for authors.
+
+=head1 LICENSE
+
+See L<Reaction::Class> for the license.
+
+=cut