Skip to content

Align loading states and documentation to the latest design guidance #1218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MisRob wants to merge 1 commit into
base: develop
Choose a base branch
from
+402 −215
Open

Align loading states and documentation to the latest design guidance #1218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions docs/pages/kcardgrid.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -592,15 +592,13 @@
</h3>

<p>
While data is loading, <code>KCardGrid</code> shows loading skeleton cards. Use the
<code>loading</code> prop to toggle the state. Note that <code>KCardGrid</code> internal
optimizations may affect how closely the visual loading experience matches the
<code>loading</code> value:
While data is loading, <code>KCardGrid</code> shows loading skeleton cards.Loading
experience is internally already optimized according to our
<DocsInternalLink
href="/loaders"
text="loading guidance"
/>. Simply use the <code>loading</code> prop to toggle the loading state.
</p>
<ul>
<li>The loading skeletons won't be displayed for short loading times (&lt; 300ms)</li>
<li>When the loading skeletons are displayed, they will be visible for at least 300ms</li>
</ul>

<h4>Loading skeletons configuration</h4>

Expand Down
92 changes: 46 additions & 46 deletions docs/pages/kcircularloader.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,59 +6,59 @@
anchor="#overview"
>
<p>Circular loaders illustrate progress by moving an indicator along a circular track.</p>
<DocsShow>
<KCircularLoader style="margin: 24px" />
</DocsShow>

See the
<DocsInternalLink
href="/loaders"
text="loaders page"
/>
for more information.
<p>
See the
<DocsInternalLink
href="/loaders"
text="loaders page"
/>
for more information and guidelines.
</p>
</DocsPageSection>

<DocsPageSection
title="Specifications"
anchor="#specifications"
title="Usage"
anchor="#usage"
>
<ul>
<li>Dimensions do not exceed 48x48px</li>
<li>Progress indicator uses palette.grey.v_800</li>
<li>Track width is 4px</li>
</ul>
</DocsPageSection>
<section>
<h3>
Determinate
<DocsAnchorTarget anchor="#determinate" />
</h3>

<DocsPageSection
title="Placement"
anchor="#placement"
>
<ul>
<li>When loading new content, center the loader</li>
<li>The loader can routinely appear and disappear when indicating a background task</li>
<li>
Do not break the flow of information or content by placing between items (e.g. list items,
content cards, table rows)
</li>
</ul>
</DocsPageSection>
<DocsExample
loadExample="KCircularLoader/Determinate.vue"
exampleId="kcircularloader-determinate"
>
<template #html>
<DocsShowCode language="html">
<KCircularLoader
type="determinate"
:progress="75"
/>
</DocsShowCode>
</template>
</DocsExample>
</section>

<DocsPageSection
title="Related"
anchor="#related"
>
<ul>
<li>
<code>KCircularLoader</code>'s <code>minVisibleTime</code> isn't sufficient when switching
between more components, for example as part of <code>v-if/v-else</code> blocks. In such
situations,
<DocsInternalLink
text="useKShow"
href="/usekshow"
/>
may come handy.
</li>
</ul>
<section>
<h3>
Indeterminate
<DocsAnchorTarget anchor="#indeterminate" />
</h3>

<DocsExample
loadExample="KCircularLoader/Indeterminate.vue"
exampleId="kcircularloader-indeterminate"
>
<template #html>
<DocsShowCode language="html">
<KCircularLoader type="indeterminate" />
</DocsShowCode>
</template>
</DocsExample>
</section>
</DocsPageSection>
</DocsPageTemplate>

Expand Down
103 changes: 47 additions & 56 deletions docs/pages/klinearloader.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,69 +5,60 @@
title="Overview"
anchor="#overview"
>
<p>Linear loaders illustrate progress by moving an indicator along a horizontal track.</p>

<p>
Linear loaders illustrate progress by moving an indicator along a horizontal track. There
are two types of linear loaders:
See the
<DocsInternalLink
href="/loaders"
text="loaders page"
/>
for more information and guidelines.
</p>

<ul>
<li>
Determinate: these loaders show a visual indicator of detectable and measurable progress
percentage
</li>
<DocsShow>
<KLinearLoader
:progress="75"
type="determinate"
class="loader"
style="width: 400px; margin: 24px"
/>
</DocsShow>
<li>
Indeterminate: these loaders show an ongoing process with an unspecified or undetectable
percentage completion
</li>
<DocsShow>
<KLinearLoader
:progress="75"
type="indeterminate"
class="loader"
style="width: 400px; margin: 24px"
/>
</DocsShow>
</ul>

See the
<DocsInternalLink
href="/loaders"
text="loaders page"
/>
for more information.
</DocsPageSection>

<DocsPageSection
title="Specifications"
anchor="#specifications"
title="Usage"
anchor="#usage"
>
<ul>
<li>Progress track uses palette.grey.v_200</li>
<li>Progress indicator uses palette.grey.v_800</li>
<li>Progress track height is 4px</li>
<li>Include a 2px corner radius</li>
<li>
Remove the corner radius when appended to other components, such as appbars or data tables
</li>
</ul>
</DocsPageSection>
<section>
<h3>
Determinate
<DocsAnchorTarget anchor="#determinate" />
</h3>

<DocsPageSection
title="Placement"
anchor="#placement"
>
<ul>
<li>Can be attached to existing components such as appbars or table rows</li>
<li>As a progress bar, should be near task-related metadata</li>
</ul>
<DocsExample
loadExample="KLinearLoader/Determinate.vue"
exampleId="klinearloader-determinate"
>
<template #html>
<DocsShowCode language="html">
<KLinearLoader
type="determinate"
:progress="75"
/>
</DocsShowCode>
</template>
</DocsExample>
</section>

<section>
<h3>
Indeterminate
<DocsAnchorTarget anchor="#indeterminate" />
</h3>

<DocsExample
loadExample="KLinearLoader/Indeterminate.vue"
exampleId="klinearloader-indeterminate"
>
<template #html>
<DocsShowCode language="html">
<KLinearLoader type="indeterminate" />
</DocsShowCode>
</template>
</DocsExample>
</section>
</DocsPageSection>
</DocsPageTemplate>

Expand Down
Loading
Loading