Skip to content

Commit 75819c3

Browse files
committed
Validators renamed attribute errorMessage -> errorText
Added documentation for validators to guide users
1 parent 45da3dd commit 75819c3

File tree

80 files changed

+478
-156
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+478
-156
lines changed

doc/api/flutter_form_builder/FormBuilderDateTimePicker-class.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ <h2>Constructors</h2>
9393

9494
<dl class="constructor-summary-list">
9595
<dt id="FormBuilderDateTimePicker" class="callable">
96-
<span class="name"><a href="flutter_form_builder/FormBuilderDateTimePicker/FormBuilderDateTimePicker.html">FormBuilderDateTimePicker</a></span><span class="signature">({<span class="parameter" id="-param-attribute"><span>@required</span> <span class="type-annotation"><a href="dart-core/String-class.html">String</a></span> <span class="parameter-name">attribute</span>, </span> <span class="parameter" id="-param-validators"><span class="type-annotation"><a href="dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter">FormFieldValidator</span>&gt;</span></span> <span class="parameter-name">validators</span>: <span class="default-value">const []</span>, </span> <span class="parameter" id="-param-readonly"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">readonly</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="-param-inputType"><span class="type-annotation">InputType</span> <span class="parameter-name">inputType</span>: <span class="default-value">InputType.both</span>, </span> <span class="parameter" id="-param-initialValue"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">initialValue</span>, </span> <span class="parameter" id="-param-format"><span class="type-annotation">DateFormat</span> <span class="parameter-name">format</span>, </span> <span class="parameter" id="-param-firstDate"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">firstDate</span>, </span> <span class="parameter" id="-param-lastDate"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">lastDate</span>, </span> <span class="parameter" id="-param-decoration"><span class="type-annotation">InputDecoration</span> <span class="parameter-name">decoration</span></span> })</span>
96+
<span class="name"><a href="flutter_form_builder/FormBuilderDateTimePicker/FormBuilderDateTimePicker.html">FormBuilderDateTimePicker</a></span><span class="signature">({<span class="parameter" id="-param-attribute"><span>@required</span> <span class="type-annotation"><a href="dart-core/String-class.html">String</a></span> <span class="parameter-name">attribute</span>, </span> <span class="parameter" id="-param-validators"><span class="type-annotation"><a href="dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter">FormFieldValidator</span>&gt;</span></span> <span class="parameter-name">validators</span>: <span class="default-value">const []</span>, </span> <span class="parameter" id="-param-readonly"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">readonly</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="-param-inputType"><span class="type-annotation">InputType</span> <span class="parameter-name">inputType</span>: <span class="default-value">InputType.both</span>, </span> <span class="parameter" id="-param-initialValue"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">initialValue</span>, </span> <span class="parameter" id="-param-format"><span class="type-annotation">DateFormat</span> <span class="parameter-name">format</span>, </span> <span class="parameter" id="-param-firstDate"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">firstDate</span>, </span> <span class="parameter" id="-param-lastDate"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">lastDate</span>, </span> <span class="parameter" id="-param-decoration"><span class="type-annotation">InputDecoration</span> <span class="parameter-name">decoration</span>: <span class="default-value">const InputDecoration()</span></span> })</span>
9797
</dt>
9898
<dd>
9999

doc/api/flutter_form_builder/FormBuilderDateTimePicker/FormBuilderDateTimePicker.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h5>FormBuilderDateTimePicker class</h5>
9797

9898
<section class="multi-line-signature">
9999

100-
<span class="name ">FormBuilderDateTimePicker</span>(<wbr>{<span class="parameter" id="-param-attribute"><span>@required</span> <span class="type-annotation"><a href="dart-core/String-class.html">String</a></span> <span class="parameter-name">attribute</span>, </span> <span class="parameter" id="-param-validators"><span class="type-annotation"><a href="dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter">FormFieldValidator</span>&gt;</span></span> <span class="parameter-name">validators</span>: <span class="default-value">const []</span>, </span> <span class="parameter" id="-param-readonly"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">readonly</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="-param-inputType"><span class="type-annotation">InputType</span> <span class="parameter-name">inputType</span>: <span class="default-value">InputType.both</span>, </span> <span class="parameter" id="-param-initialValue"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">initialValue</span>, </span> <span class="parameter" id="-param-format"><span class="type-annotation">DateFormat</span> <span class="parameter-name">format</span>, </span> <span class="parameter" id="-param-firstDate"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">firstDate</span>, </span> <span class="parameter" id="-param-lastDate"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">lastDate</span>, </span> <span class="parameter" id="-param-decoration"><span class="type-annotation">InputDecoration</span> <span class="parameter-name">decoration</span></span> })
100+
<span class="name ">FormBuilderDateTimePicker</span>(<wbr>{<span class="parameter" id="-param-attribute"><span>@required</span> <span class="type-annotation"><a href="dart-core/String-class.html">String</a></span> <span class="parameter-name">attribute</span>, </span> <span class="parameter" id="-param-validators"><span class="type-annotation"><a href="dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter">FormFieldValidator</span>&gt;</span></span> <span class="parameter-name">validators</span>: <span class="default-value">const []</span>, </span> <span class="parameter" id="-param-readonly"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">readonly</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="-param-inputType"><span class="type-annotation">InputType</span> <span class="parameter-name">inputType</span>: <span class="default-value">InputType.both</span>, </span> <span class="parameter" id="-param-initialValue"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">initialValue</span>, </span> <span class="parameter" id="-param-format"><span class="type-annotation">DateFormat</span> <span class="parameter-name">format</span>, </span> <span class="parameter" id="-param-firstDate"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">firstDate</span>, </span> <span class="parameter" id="-param-lastDate"><span class="type-annotation"><a href="dart-core/DateTime-class.html">DateTime</a></span> <span class="parameter-name">lastDate</span>, </span> <span class="parameter" id="-param-decoration"><span class="type-annotation">InputDecoration</span> <span class="parameter-name">decoration</span>: <span class="default-value">const InputDecoration()</span></span> })
101101
</section>
102102

103103

@@ -112,7 +112,7 @@ <h2><span>Implementation</span></h2>
112112
this.format,
113113
this.firstDate,
114114
this.lastDate,
115-
this.decoration,
115+
this.decoration = const InputDecoration(),
116116
});</code></pre>
117117
</section>
118118

doc/api/flutter_form_builder/FormBuilderFieldState/build.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ <h2><span>Implementation</span></h2>
184184
Widget build(BuildContext context) {
185185
&#47;*return widget.formField
186186
..onSaved = (T val) {
187-
FormBuilder.of(context).setValue(widget.attribute, val);
187+
FormBuilder.of(context)?.setValue(widget.attribute, val);
188188
if (widget.formField.onSaved != null) widget.formField.onSaved(val);
189189
}
190190
..validator = (val) {
@@ -199,7 +199,7 @@ <h2><span>Implementation</span></h2>
199199
key: Key(widget.attribute),
200200
child: FormField(
201201
onSaved: (val) {
202-
FormBuilder.of(context).setValue(widget.attribute, val);
202+
FormBuilder.of(context)?.setAttributeValue(widget.attribute, val);
203203
if (widget.formField.onSaved != null) widget.formField.onSaved(val);
204204
},
205205
validator: (val) {

doc/api/flutter_form_builder/FormBuilderSegmentedControl/createState.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,8 @@ <h5>FormBuilderSegmentedControl class</h5>
122122
<section class="summary source-code" id="source">
123123
<h2><span>Implementation</span></h2>
124124
<pre class="language-dart"><code class="language-dart">@override
125-
_FormBuilderSegmentedControlState createState() =&gt; _FormBuilderSegmentedControlState();</code></pre>
125+
_FormBuilderSegmentedControlState createState() =&gt;
126+
_FormBuilderSegmentedControlState();</code></pre>
126127
</section>
127128

128129
</div> <!-- /.main-content -->

doc/api/flutter_form_builder/FormBuilderSlider-class.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ <h2>Constructors</h2>
9393

9494
<dl class="constructor-summary-list">
9595
<dt id="FormBuilderSlider" class="callable">
96-
<span class="name"><a href="flutter_form_builder/FormBuilderSlider/FormBuilderSlider.html">FormBuilderSlider</a></span><span class="signature">({<span class="parameter" id="-param-attribute"><span>@required</span> <span class="type-annotation"><a href="dart-core/String-class.html">String</a></span> <span class="parameter-name">attribute</span>, </span> <span class="parameter" id="-param-min"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">min</span>, </span> <span class="parameter" id="-param-max"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">max</span>, </span> <span class="parameter" id="-param-initialValue"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">initialValue</span>, </span> <span class="parameter" id="-param-validators"><span class="type-annotation"><a href="dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter">FormFieldValidator</span>&gt;</span></span> <span class="parameter-name">validators</span>: <span class="default-value">const []</span>, </span> <span class="parameter" id="-param-readonly"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">readonly</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="-param-decoration"><span class="type-annotation">InputDecoration</span> <span class="parameter-name">decoration</span>, </span> <span class="parameter" id="-param-divisions"><span class="type-annotation"><a href="dart-core/int-class.html">int</a></span> <span class="parameter-name">divisions</span></span> })</span>
96+
<span class="name"><a href="flutter_form_builder/FormBuilderSlider/FormBuilderSlider.html">FormBuilderSlider</a></span><span class="signature">({<span class="parameter" id="-param-attribute"><span>@required</span> <span class="type-annotation"><a href="dart-core/String-class.html">String</a></span> <span class="parameter-name">attribute</span>, </span> <span class="parameter" id="-param-min"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">min</span>, </span> <span class="parameter" id="-param-max"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">max</span>, </span> <span class="parameter" id="-param-initialValue"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">initialValue</span>, </span> <span class="parameter" id="-param-validators"><span class="type-annotation"><a href="dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter">FormFieldValidator</span>&gt;</span></span> <span class="parameter-name">validators</span>: <span class="default-value">const []</span>, </span> <span class="parameter" id="-param-readonly"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">readonly</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="-param-decoration"><span class="type-annotation">InputDecoration</span> <span class="parameter-name">decoration</span>: <span class="default-value">const InputDecoration()</span>, </span> <span class="parameter" id="-param-divisions"><span class="type-annotation"><a href="dart-core/int-class.html">int</a></span> <span class="parameter-name">divisions</span></span> })</span>
9797
</dt>
9898
<dd>
9999

doc/api/flutter_form_builder/FormBuilderSlider/FormBuilderSlider.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h5>FormBuilderSlider class</h5>
9696

9797
<section class="multi-line-signature">
9898

99-
<span class="name ">FormBuilderSlider</span>(<wbr>{<span class="parameter" id="-param-attribute"><span>@required</span> <span class="type-annotation"><a href="dart-core/String-class.html">String</a></span> <span class="parameter-name">attribute</span>, </span> <span class="parameter" id="-param-min"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">min</span>, </span> <span class="parameter" id="-param-max"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">max</span>, </span> <span class="parameter" id="-param-initialValue"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">initialValue</span>, </span> <span class="parameter" id="-param-validators"><span class="type-annotation"><a href="dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter">FormFieldValidator</span>&gt;</span></span> <span class="parameter-name">validators</span>: <span class="default-value">const []</span>, </span> <span class="parameter" id="-param-readonly"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">readonly</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="-param-decoration"><span class="type-annotation">InputDecoration</span> <span class="parameter-name">decoration</span>, </span> <span class="parameter" id="-param-divisions"><span class="type-annotation"><a href="dart-core/int-class.html">int</a></span> <span class="parameter-name">divisions</span></span> })
99+
<span class="name ">FormBuilderSlider</span>(<wbr>{<span class="parameter" id="-param-attribute"><span>@required</span> <span class="type-annotation"><a href="dart-core/String-class.html">String</a></span> <span class="parameter-name">attribute</span>, </span> <span class="parameter" id="-param-min"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">min</span>, </span> <span class="parameter" id="-param-max"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">max</span>, </span> <span class="parameter" id="-param-initialValue"><span>@required</span> <span class="type-annotation"><a href="dart-core/num-class.html">num</a></span> <span class="parameter-name">initialValue</span>, </span> <span class="parameter" id="-param-validators"><span class="type-annotation"><a href="dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter">FormFieldValidator</span>&gt;</span></span> <span class="parameter-name">validators</span>: <span class="default-value">const []</span>, </span> <span class="parameter" id="-param-readonly"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">readonly</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="-param-decoration"><span class="type-annotation">InputDecoration</span> <span class="parameter-name">decoration</span>: <span class="default-value">const InputDecoration()</span>, </span> <span class="parameter" id="-param-divisions"><span class="type-annotation"><a href="dart-core/int-class.html">int</a></span> <span class="parameter-name">divisions</span></span> })
100100
</section>
101101

102102

@@ -109,7 +109,7 @@ <h2><span>Implementation</span></h2>
109109
@required this.initialValue,
110110
this.validators = const [],
111111
this.readonly = false,
112-
this.decoration,
112+
this.decoration = const InputDecoration(),
113113
this.divisions,
114114
});</code></pre>
115115
</section>

0 commit comments

Comments
 (0)