Skip to content

Commit cf6d802

Browse files
committed
doc: deploy PR #807 preview
1 parent e17ca12 commit cf6d802

4 files changed

Lines changed: 7 additions & 13 deletions

File tree

docs/prPreview/807/components_list_item_ouds_small_list_item/OudsSmallListItem-class.html

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,7 @@ <h2 id="parameters">Parameters</h2>
9393
<li><a href="../components_list_item_ouds_small_list_item/OudsSmallListItem/trailing.html">trailing</a>: Optional trailing content. Accepts <a href="../components_list_item_ouds_small_list_item/OudsSmallListItemTrailingIcon-class.html">OudsSmallListItemTrailingIcon</a>,
9494
<a href="../components_list_item_ouds_small_list_item/OudsSmallListItemTrailingImage-class.html">OudsSmallListItemTrailingImage</a> or <a href="../components_list_item_ouds_small_list_item/OudsSmallListItemTrailingText-class.html">OudsSmallListItemTrailingText</a>.</li>
9595
<li><a href="../components_list_item_ouds_small_list_item/OudsSmallListItem/divider.html">divider</a>: Whether a horizontal divider is drawn below the item. Defaults to <code>true</code>.</li>
96-
<li><a href="../components_list_item_ouds_small_list_item/OudsSmallListItem/background.html">background</a>: Whether the item has a persistent background color. Defaults to <code>true</code> (matches Android).
97-
Set to <code>false</code> for navigation items where interaction feedback is preferred.</li>
96+
<li><a href="../components_list_item_ouds_small_list_item/OudsSmallListItem/background.html">background</a>: Whether the item has a persistent background color. Defaults to <code>false</code>.</li>
9897
<li><a href="../components_list_item_ouds_small_list_item/OudsSmallListItem/helperText.html">helperText</a>: Optional helper text displayed below the row (and below the divider).</li>
9998
<li><a href="../components_list_item_ouds_small_list_item/OudsSmallListItem/boldLabel.html">boldLabel</a>: Whether <a href="../components_list_item_ouds_small_list_item/OudsSmallListItem/label.html">label</a> is rendered in bold. Defaults to <code>false</code>.</li>
10099
<li><a href="../components_list_item_ouds_small_list_item/OudsSmallListItem/enable.html">enable</a>: Whether the item is interactive. Defaults to <code>true</code>.</li>
@@ -113,7 +112,6 @@ <h3 id="usage-example">Usage Example</h3>
113112
// Navigation compact item
114113
OudsSmallListItem(
115114
label: 'Navigate',
116-
background: false,
117115
onTap: () =&gt; Navigator.of(context).push(…),
118116
);
119117

@@ -156,7 +154,7 @@ <h3 id="usage-example">Usage Example</h3>
156154
<h2>Constructors</h2>
157155
<dl class="constructor-summary-list">
158156
<dt id="OudsSmallListItem.new" class="callable">
159-
<span class="name"><a href="../components_list_item_ouds_small_list_item/OudsSmallListItem/OudsSmallListItem.html">OudsSmallListItem</a></span><span class="signature">({<span class="parameter" id="param-key"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/foundation/Key-class.html">Key</a>?</span> <span class="parameter-name">key</span>, </span><span class="parameter" id="param-label"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">label</span>, </span><span class="parameter" id="param-contentAlignment"><span class="type-annotation"><a href="../components_list_item_ouds_list_item/OudsListItemContentAlignment.html">OudsListItemContentAlignment</a></span> <span class="parameter-name">contentAlignment</span> = <span class="default-value">OudsListItemDefaults.contentAlignment</span>, </span><span class="parameter" id="param-description"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">description</span>, </span><span class="parameter" id="param-leading"><span class="type-annotation"><a href="../components_list_item_ouds_small_list_item/OudsSmallListItemLeading-class.html">OudsSmallListItemLeading</a>?</span> <span class="parameter-name">leading</span>, </span><span class="parameter" id="param-trailing"><span class="type-annotation"><a href="../components_list_item_ouds_small_list_item/OudsSmallListItemTrailing-class.html">OudsSmallListItemTrailing</a>?</span> <span class="parameter-name">trailing</span>, </span><span class="parameter" id="param-divider"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">divider</span> = <span class="default-value">true</span>, </span><span class="parameter" id="param-background"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">background</span> = <span class="default-value">true</span>, </span><span class="parameter" id="param-helperText"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">helperText</span>, </span><span class="parameter" id="param-boldLabel"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">boldLabel</span> = <span class="default-value">false</span>, </span><span class="parameter" id="param-enable"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">enable</span> = <span class="default-value">true</span>, </span><span class="parameter" id="param-onTap"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-ui/VoidCallback.html">VoidCallback</a>?</span> <span class="parameter-name">onTap</span>, </span><span class="parameter" id="param-indicator"><span class="type-annotation"><a href="../components_list_item_internal_ouds_list_item_types/OudsListItemIndicator-class.html">OudsListItemIndicator</a></span> <span class="parameter-name">indicator</span> = <span class="default-value">OudsListItemDefaults.indicator</span></span>})</span>
157+
<span class="name"><a href="../components_list_item_ouds_small_list_item/OudsSmallListItem/OudsSmallListItem.html">OudsSmallListItem</a></span><span class="signature">({<span class="parameter" id="param-key"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/foundation/Key-class.html">Key</a>?</span> <span class="parameter-name">key</span>, </span><span class="parameter" id="param-label"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">label</span>, </span><span class="parameter" id="param-contentAlignment"><span class="type-annotation"><a href="../components_list_item_ouds_list_item/OudsListItemContentAlignment.html">OudsListItemContentAlignment</a></span> <span class="parameter-name">contentAlignment</span> = <span class="default-value">OudsListItemDefaults.contentAlignment</span>, </span><span class="parameter" id="param-description"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">description</span>, </span><span class="parameter" id="param-leading"><span class="type-annotation"><a href="../components_list_item_ouds_small_list_item/OudsSmallListItemLeading-class.html">OudsSmallListItemLeading</a>?</span> <span class="parameter-name">leading</span>, </span><span class="parameter" id="param-trailing"><span class="type-annotation"><a href="../components_list_item_ouds_small_list_item/OudsSmallListItemTrailing-class.html">OudsSmallListItemTrailing</a>?</span> <span class="parameter-name">trailing</span>, </span><span class="parameter" id="param-divider"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">divider</span> = <span class="default-value">true</span>, </span><span class="parameter" id="param-background"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">background</span> = <span class="default-value">false</span>, </span><span class="parameter" id="param-helperText"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">helperText</span>, </span><span class="parameter" id="param-boldLabel"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">boldLabel</span> = <span class="default-value">false</span>, </span><span class="parameter" id="param-enable"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">enable</span> = <span class="default-value">true</span>, </span><span class="parameter" id="param-onTap"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-ui/VoidCallback.html">VoidCallback</a>?</span> <span class="parameter-name">onTap</span>, </span><span class="parameter" id="param-indicator"><span class="type-annotation"><a href="../components_list_item_internal_ouds_list_item_types/OudsListItemIndicator-class.html">OudsListItemIndicator</a></span> <span class="parameter-name">indicator</span> = <span class="default-value">OudsListItemDefaults.indicator</span></span>})</span>
160158
</dt>
161159
<dd>
162160

@@ -177,7 +175,7 @@ <h2>Properties</h2>
177175

178176
</dt>
179177
<dd>
180-
Whether the item has a persistent background color.
178+
Whether the item has a persistent background color. Defaults to <code>false</code>.
181179
<div class="features"><span class="feature">final</span></div>
182180

183181
</dd>

docs/prPreview/807/components_list_item_ouds_small_list_item/OudsSmallListItem/OudsSmallListItem.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ <h1><span class="kind-constructor">OudsSmallListItem</span> constructor
6161
<li><span class="parameter" id="param-leading"><span class="type-annotation"><a href="../../components_list_item_ouds_small_list_item/OudsSmallListItemLeading-class.html">OudsSmallListItemLeading</a>?</span> <span class="parameter-name">leading</span>, </span></li>
6262
<li><span class="parameter" id="param-trailing"><span class="type-annotation"><a href="../../components_list_item_ouds_small_list_item/OudsSmallListItemTrailing-class.html">OudsSmallListItemTrailing</a>?</span> <span class="parameter-name">trailing</span>, </span></li>
6363
<li><span class="parameter" id="param-divider"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">divider</span> = <span class="default-value">true</span>, </span></li>
64-
<li><span class="parameter" id="param-background"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">background</span> = <span class="default-value">true</span>, </span></li>
64+
<li><span class="parameter" id="param-background"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">background</span> = <span class="default-value">false</span>, </span></li>
6565
<li><span class="parameter" id="param-helperText"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">helperText</span>, </span></li>
6666
<li><span class="parameter" id="param-boldLabel"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">boldLabel</span> = <span class="default-value">false</span>, </span></li>
6767
<li><span class="parameter" id="param-enable"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">enable</span> = <span class="default-value">true</span>, </span></li>
@@ -83,7 +83,7 @@ <h2><span>Implementation</span></h2>
8383
this.leading,
8484
this.trailing,
8585
this.divider = true,
86-
this.background = true,
86+
this.background = false,
8787
this.helperText,
8888
this.boldLabel = false,
8989
this.enable = true,

docs/prPreview/807/components_list_item_ouds_small_list_item/OudsSmallListItem/background.html

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,7 @@ <h1><span class="kind-property">background</span> property
6262
</section>
6363

6464
<section class="desc markdown">
65-
<p>Whether the item has a persistent background color.</p>
66-
<p>Defaults to <code>true</code> for static (read-only) items — matches the Android default.
67-
Note: this differs from <a href="../../components_list_item_ouds_list_item/OudsListItem-class.html">OudsListItem</a> which defaults to <code>false</code>, because
68-
<a href="../../components_list_item_ouds_small_list_item/OudsSmallListItem-class.html">OudsSmallListItem</a> is primarily designed for static/read-only use cases.
69-
Set to <code>false</code> for navigation items where pressed/hover interaction feedback is preferred.</p>
65+
<p>Whether the item has a persistent background color. Defaults to <code>false</code>.</p>
7066
</section>
7167

7268

docs/prPreview/807/index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)