Skip to content

Commit 2e1b2f3

Browse files
actions-useractions-user
committed
doc: deploy PR #804 preview
1 parent cf6d802 commit 2e1b2f3

11 files changed

Lines changed: 80 additions & 71 deletions

File tree

‎docs/prPreview/804/components_progress_indicator_ouds_progress_indicator/OudsCircularProgressIndicator-class.html‎

Lines changed: 16 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -55,32 +55,24 @@ <h1><span class="kind-class">OudsCircularProgressIndicator</span> class
5555

5656
<section class="desc markdown">
5757
<p><strong>Reference design version : 1.0.0</strong></p>
58-
<p>A Circular Progress Indicator shows the progress of a task using a circle. Useful when you need more visual focus or when space is limited.</p>
59-
<p>This version of the circular progress indicator is <strong>determinate</strong>. Use the other signature for an indeterminate progress.</p>
60-
<p>The component automatically scales all dimensions (stroke width, gap size) proportionally based on its effective size
61-
(after applying the modifier). A scale factor is calculated by dividing the actual size by the default size from tokens,
62-
then this scale is applied to all dimensions to maintain consistent proportions.</p>
63-
<p>Parameters:</p>
58+
<p>A circular progress indicator that shows the progress of a task as a ring.
59+
Useful when more visual focus is needed or when space is limited.</p>
60+
<p>All dimensions (stroke width, gap size) scale proportionally based on the
61+
effective component size, which itself follows the system text-scale factor.</p>
62+
<h2 id="parameters">Parameters</h2>
6463
<ul>
65-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/progressType.html">progressType</a>: Defines whether the indicator is determinate or indeterminate.</li>
66-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/status.html">status</a>: Represents the visual status of the indicator. Its color is based on this status.
67-
Progress indicators can use different statuses depending on the meaning of the process they represent. Status colors should communicate the nature of the operation, not its completion percentage.
68-
There are two types of statuses:
69-
<ul>
70-
<li>Non-functional statuses <a href="../components_common_ouds_icon_status/Neutral-class.html">Neutral</a> or <a href="../components_common_ouds_icon_status/Accent-class.html">Accent</a> used for standard progress indication without conveying any semantic feedback.
71-
They simply communicate that a process is running or progressing.</li>
72-
<li>Functional statuses communicate additional semantic meaning about the operation being performed.
73-
They should only be used when the process itself represents a meaningful system state.: <a href="../components_common_ouds_icon_status/Positive-class.html">Positive</a>, <a href="../components_common_ouds_icon_status/Warning-class.html">Warning</a>,
74-
<a href="../components_common_ouds_icon_status/Negative-class.html">Negative</a>, <a href="../components_common_ouds_icon_status/Info-class.html">Info</a>.</li>
75-
</ul>
76-
</li>
77-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/animated.html">animated</a>: If true, enables animation when updating the progress.</li>
78-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/progress.html">progress</a>: The current progress value, between 0.0 and 1.0. If null, the indicator is indeterminate.</li>
79-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/gapSize.html">gapSize</a>: The size of the gap in the circular indicator <a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicatorGapSize.html">OudsProgressIndicatorGapSize</a>.</li>
80-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/track.html">track</a>: If true, displays the track (background) of the indicator.</li>
81-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/semanticLabel.html">semanticLabel</a>: Semantic label for accessibility.</li>
64+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/progressType.html">progressType</a>: Determinate or indeterminate display mode.</li>
65+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/status.html">status</a>: Visual color status. Non-semantic (<a href="../components_common_ouds_icon_status/Neutral-class.html">Neutral</a>, <a href="../components_common_ouds_icon_status/Accent-class.html">Accent</a>) for
66+
standard progress; semantic (<a href="../components_common_ouds_icon_status/Positive-class.html">Positive</a>, <a href="../components_common_ouds_icon_status/Warning-class.html">Warning</a>, <a href="../components_common_ouds_icon_status/Negative-class.html">Negative</a>, <a href="../components_common_ouds_icon_status/Info-class.html">Info</a>)
67+
when the operation carries a meaning.</li>
68+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/animated.html">animated</a>: Enables smooth value-change animation (determinate only).
69+
Automatically disabled when the OS reduced-motion setting is on.</li>
70+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/progress.html">progress</a>: Value between <code>0.0</code> and <code>1.0</code>. Pass <code>null</code> for indeterminate.</li>
71+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/gapSize.html">gapSize</a>: Gap between the active arc and its track — <a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicatorGapSize.html">OudsProgressIndicatorGapSize</a>.</li>
72+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/track.html">track</a>: Whether the background track ring is visible.</li>
73+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/semanticLabel.html">semanticLabel</a>: Accessibility label for assistive technologies.</li>
8274
</ul>
83-
<h2 id="example-of-usage">Example of usage</h2>
75+
<h2 id="example">Example</h2>
8476
<pre class="language-dart"><code class="language-dart">OudsCircularProgressIndicator(
8577
progressType: OudsProgressIndicatorType.determinate,
8678
status: Positive(),

‎docs/prPreview/804/components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator-class.html‎

Lines changed: 31 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -55,47 +55,39 @@ <h1><span class="kind-class">OudsLinearProgressIndicator</span> class
5555

5656
<section class="desc markdown">
5757
<p><strong>Reference design version : 1.0.0</strong></p>
58-
<p>A Linear Progress Indicator shows the progress of a task using a horizontal line.
59-
It can show a specific value (determinate) or just that something is in progress (indeterminate).
60-
Best used inside layouts to show progress.</p>
58+
<p>A linear progress indicator that shows the progress of a task as a
59+
horizontal bar. Supports both determinate and indeterminate modes and is
60+
best placed inside layouts where vertical space is available.</p>
6161
<p>The component can optionally display:</p>
6262
<ul>
6363
<li>a stop indicator at the end of the active bar,</li>
6464
<li>helper text below the indicator,</li>
6565
<li>a percentage value,</li>
66-
<li>and custom alignment for the helper text.</li>
66+
<li>and custom horizontal alignment for the helper text.</li>
6767
</ul>
68-
<h1 id="parameters">Parameters:</h1>
68+
<h2 id="parameters">Parameters</h2>
6969
<ul>
70-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/progressType.html">progressType</a>: Defines whether the indicator is determinate or indeterminate.</li>
71-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/status.html">status</a>: Represents the visual status of the indicator. Its color is based on this status.
72-
Progress indicators can use different statuses depending on the meaning of the process they represent. Status colors should communicate the nature of the operation, not its completion percentage.
73-
There are two types of statuses:
74-
<ul>
75-
<li>Non-functional statuses <a href="../components_common_ouds_icon_status/Neutral-class.html">Neutral</a> or <a href="../components_common_ouds_icon_status/Accent-class.html">Accent</a> used for standard progress indication without conveying any semantic feedback.
76-
They simply communicate that a process is running or progressing.</li>
77-
<li>Functional statuses communicate additional semantic meaning about the operation being performed.
78-
They should only be used when the process itself represents a meaningful system state.: <a href="../components_common_ouds_icon_status/Positive-class.html">Positive</a>, <a href="../components_common_ouds_icon_status/Warning-class.html">Warning</a>,
79-
<a href="../components_common_ouds_icon_status/Negative-class.html">Negative</a>, <a href="../components_common_ouds_icon_status/Info-class.html">Info</a>.</li>
80-
</ul>
81-
</li>
82-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/animated.html">animated</a>: If true, enables animation when updating the progress.</li>
83-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/progress.html">progress</a>: The current progress value, between 0.0 and 1.0. If null, the indicator is indeterminate.</li>
84-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/gapSize.html">gapSize</a>: The size of the gap in the linear indicator <a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicatorGapSize.html">OudsProgressIndicatorGapSize</a>.</li>
85-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/track.html">track</a>: If true, displays the track (background) of the indicator.</li>
86-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/semanticLabel.html">semanticLabel</a>: Semantic label for accessibility.</li>
87-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/stopIndicator.html">stopIndicator</a>: If true, displays a stop indicator at the end of the progress.</li>
70+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/progressType.html">progressType</a>: Determinate or indeterminate display mode.</li>
71+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/status.html">status</a>: Visual color status. Non-semantic (<a href="../components_common_ouds_icon_status/Neutral-class.html">Neutral</a>, <a href="../components_common_ouds_icon_status/Accent-class.html">Accent</a>) for
72+
standard progress; semantic (<a href="../components_common_ouds_icon_status/Positive-class.html">Positive</a>, <a href="../components_common_ouds_icon_status/Warning-class.html">Warning</a>, <a href="../components_common_ouds_icon_status/Negative-class.html">Negative</a>, <a href="../components_common_ouds_icon_status/Info-class.html">Info</a>)
73+
when the operation carries a meaning.</li>
74+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/animated.html">animated</a>: Enables smooth value-change animation (determinate only).
75+
Automatically disabled when the OS reduced-motion setting is on.</li>
76+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/progress.html">progress</a>: Value between <code>0.0</code> and <code>1.0</code>. Pass <code>null</code> for indeterminate.</li>
77+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/gapSize.html">gapSize</a>: Gap between the active bar and its track — <a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicatorGapSize.html">OudsProgressIndicatorGapSize</a>.</li>
78+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/track.html">track</a>: Whether the background track bar is visible.</li>
79+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/semanticLabel.html">semanticLabel</a>: Accessibility label for assistive technologies.</li>
80+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/stopIndicator.html">stopIndicator</a>: Displays a square (or circle when rounded) block at the
81+
end of the active bar.</li>
8882
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/helperText.html">helperText</a>: Optional text displayed below the indicator.</li>
89-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/helperTextAlignment.html">helperTextAlignment</a>: Alignment of the helper text <a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicatorHelperTextAlignment.html">OudsProgressIndicatorHelperTextAlignment</a>.</li>
90-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/percentage.html">percentage</a>: Displays the progress percentage in the helper text area .
91-
<ul>
92-
<li>If <code>false</code>, the provided <a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/helperText.html">helperText</a> is returned.</li>
93-
<li>If <code>true</code>, the helper text is generated from <a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/progress.html">progress</a> and formatted as a percentage.</li>
83+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/helperTextAlignment.html">helperTextAlignment</a>: Horizontal alignment of the helper text —
84+
<a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicatorHelperTextAlignment.html">OudsProgressIndicatorHelperTextAlignment</a>.</li>
85+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/percentage.html">percentage</a>: When <code>true</code>, the helper text is generated from <a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator/progress.html">progress</a>
86+
and formatted as a percentage; when <code>false</code>, <a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/helperText.html">helperText</a> is used.</li>
87+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/spaceBeforePercentage.html">spaceBeforePercentage</a>: Inserts a non-breaking space before the <code>%</code>
88+
symbol when <a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/percentage.html">percentage</a> is <code>true</code> (e.g. <code>75 %</code> instead of <code>75%</code>).</li>
9489
</ul>
95-
</li>
96-
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/spaceBeforePercentage.html">spaceBeforePercentage</a>: Inserts a space before the percentage symbol when percentage is displayed.</li>
97-
</ul>
98-
<h2 id="example-of-usage">Example of usage</h2>
90+
<h2 id="example">Example</h2>
9991
<pre class="language-dart"><code class="language-dart">OudsLinearProgressIndicator(
10092
progressType: OudsProgressIndicatorType.determinate,
10193
status: Positive(),
@@ -200,7 +192,7 @@ <h2>Properties</h2>
200192

201193
</dt>
202194
<dd>
203-
195+
Optional text displayed below the indicator.
204196
<div class="features"><span class="feature">final</span></div>
205197

206198
</dd>
@@ -212,7 +204,7 @@ <h2>Properties</h2>
212204

213205
</dt>
214206
<dd>
215-
207+
Horizontal alignment of the helper text below the indicator.
216208
<div class="features"><span class="feature">final</span></div>
217209

218210
</dd>
@@ -236,7 +228,8 @@ <h2>Properties</h2>
236228

237229
</dt>
238230
<dd>
239-
231+
When <code>true</code>, the helper text is replaced by the formatted progress
232+
percentage (e.g. <code>75%</code>). <a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/helperText.html">helperText</a> is ignored.
240233
<div class="features"><span class="feature">final</span></div>
241234

242235
</dd>
@@ -296,7 +289,8 @@ <h2>Properties</h2>
296289

297290
</dt>
298291
<dd>
299-
292+
Inserts a space between the numeric value and the <code>%</code> symbol when
293+
<a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/percentage.html">percentage</a> is <code>true</code> (e.g. <code>75 %</code> instead of <code>75%</code>).
300294
<div class="features"><span class="feature">final</span></div>
301295

302296
</dd>
@@ -320,7 +314,7 @@ <h2>Properties</h2>
320314

321315
</dt>
322316
<dd>
323-
317+
Whether to display a stop block at the right end of the active bar.
324318
<div class="features"><span class="feature">final</span></div>
325319

326320
</dd>

‎docs/prPreview/804/components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/helperText.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ <h1><span class="kind-property">helperText</span> property
6161

6262
</section>
6363

64+
<section class="desc markdown">
65+
<p>Optional text displayed below the indicator.</p>
66+
<p>Ignored when <a href="../../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/percentage.html">percentage</a> is <code>true</code>.</p>
67+
</section>
6468

6569

6670
<section class="summary source-code" id="source">

‎docs/prPreview/804/components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/helperTextAlignment.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ <h1><span class="kind-property">helperTextAlignment</span> property
6161

6262
</section>
6363

64+
<section class="desc markdown">
65+
<p>Horizontal alignment of the helper text below the indicator.</p>
66+
</section>
6467

6568

6669
<section class="summary source-code" id="source">

‎docs/prPreview/804/components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/percentage.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ <h1><span class="kind-property">percentage</span> property
6161

6262
</section>
6363

64+
<section class="desc markdown">
65+
<p>When <code>true</code>, the helper text is replaced by the formatted progress
66+
percentage (e.g. <code>75%</code>). <a href="../../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/helperText.html">helperText</a> is ignored.</p>
67+
</section>
6468

6569

6670
<section class="summary source-code" id="source">

‎docs/prPreview/804/components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/spaceBeforePercentage.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ <h1><span class="kind-property">spaceBeforePercentage</span> property
6161

6262
</section>
6363

64+
<section class="desc markdown">
65+
<p>Inserts a space between the numeric value and the <code>%</code> symbol when
66+
<a href="../../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/percentage.html">percentage</a> is <code>true</code> (e.g. <code>75 %</code> instead of <code>75%</code>).</p>
67+
</section>
6468

6569

6670
<section class="summary source-code" id="source">

‎docs/prPreview/804/components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator/stopIndicator.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,11 @@ <h1><span class="kind-property">stopIndicator</span> property
6161

6262
</section>
6363

64+
<section class="desc markdown">
65+
<p>Whether to display a stop block at the right end of the active bar.</p>
66+
<p>The block is square when the theme uses default corners and circular when
67+
rounded corners are enabled.</p>
68+
</section>
6469

6570

6671
<section class="summary source-code" id="source">

‎docs/prPreview/804/components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator-class.html‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,13 @@ <h1><span class="kind-class">OudsProgressIndicator</span> class
5555

5656

5757
<section class="desc markdown">
58-
<p>A base class for <a href="../components_progress_indicator_ouds_progress_indicator/OudsProgressIndicator-class.html">OudsProgressIndicator</a> Flutter Design progress indicators.</p>
59-
<p>This widget cannot be instantiated directly. For a linear progress
60-
indicator, see <a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator-class.html">OudsLinearProgressIndicator</a>. For a circular progress indicator,
61-
see <a href="../components_progress_indicator_ouds_progress_indicator/OudsCircularProgressIndicator-class.html">OudsCircularProgressIndicator</a>.</p>
58+
<p>Abstract base class for all OUDS progress indicator widgets.</p>
59+
<p>This widget cannot be instantiated directly. Use one of the concrete
60+
sub-classes instead:</p>
61+
<ul>
62+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsCircularProgressIndicator-class.html">OudsCircularProgressIndicator</a> — ring-shaped indicator.</li>
63+
<li><a href="../components_progress_indicator_ouds_progress_indicator/OudsLinearProgressIndicator-class.html">OudsLinearProgressIndicator</a> — horizontal bar indicator.</li>
64+
</ul>
6265
</section>
6366

6467

0 commit comments

Comments
 (0)