Skip to content
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

Jump to bottom

Feat/improve progress radial #2093

Merged
merged 10 commits into from
Oct 6, 2023
Merged

Feat/improve progress radial #2093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5f14738
feat: add roundedLineCap property
edrichhans Oct 1, 2023
aa5d65e
fix: offset radius of progress radial meter
edrichhans Oct 1, 2023
5047234
test: add optional roundedLineCap to progressRadial
edrichhans Oct 1, 2023
e47705d
feat: document roundedLineCap
edrichhans Oct 1, 2023
9affbdc
chore: run format
edrichhans Oct 1, 2023
60bcde0
chore: run changeset
edrichhans Oct 1, 2023
3438f46
fix: add offset to the radius
edrichhans Oct 1, 2023
e707411
Additional edits to Progress Radials
endigo9740 Oct 6, 2023
313a4a7
Resolve type error
endigo9740 Oct 6, 2023
638b7c0
...
endigo9740 Oct 6, 2023
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
5 changes: 5 additions & 0 deletions .changeset/little-dingos-repeat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@skeletonlabs/skeleton": patch
---

feat: Added a `strokeLinecap` property to to Progress Radials, enabling rounded styling
9 changes: 6 additions & 3 deletions packages/skeleton/src/lib/components/ProgressRadial/ProgressRadial.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
export let stroke = 40; // px
/** Sets the base font size. Scales responsively. */
export let font = 56; // px
/** Sets the stoke-linecap value */
export let strokeLinecap: 'butt' | 'round' | 'square' = 'butt';

// Props (styles)
/** Provide classes to set the width. */
Expand All @@ -37,7 +39,7 @@

// Calculated Values
const baseSize = 512; // px
const radius: number = baseSize / 2;
const radius: number = baseSize / 2 - stroke / 2;
let circumference: number = radius;
let dashoffset: number;

Expand Down Expand Up @@ -73,18 +75,19 @@
<!-- Draw SVG -->
<svg viewBox="0 0 {baseSize} {baseSize}" class="rounded-full" class:animate-spin={value === undefined}>
<!-- Track -->
<circle class="progress-radial-track {cBaseTrack} {track}" stroke-width={stroke} r={baseSize / 2} cx="50%" cy="50%" />
<circle class="progress-radial-track {cBaseTrack} {track}" stroke-width={stroke} r={radius} cx="50%" cy="50%" />

<!-- Meter -->
<circle
class="progress-radial-meter {cBaseMeter} {meter}"
stroke-width={stroke}
r={baseSize / 2}
r={radius}
cx="50%"
cy="50%"
style:stroke-dasharray="{circumference}
{circumference}"
style:stroke-dashoffset={dashoffset}
stroke-linecap={strokeLinecap}
/>

<!-- Center Text -->
Expand Down
3 changes: 2 additions & 1 deletion packages/skeleton/src/lib/components/ProgressRadial/ProgressRadial.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ describe('ProgressRadial.svelte', () => {
meter: 'stroke-black dark:stroke-white',
color: 'fill-black dark:fill-white',
font: 56,
label: 'testProgressRadial1'
label: 'testProgressRadial1',
roundedLineCap: true
}
});
expect(getByTestId('progress-radial')).toBeTruthy();
Expand Down
72 changes: 61 additions & 11 deletions sites/skeleton.dev/src/routes/(inner)/components/progress-radials/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
// Reactive
$: props = { value: 50, max: 100, step: 10 };
$: strokeProps = { value: 100, max: 400, step: 20 };
let strokeLinecap: 'butt' | 'round' | 'square' = 'butt';
</script>

<DocsShell {settings}>
Expand All @@ -45,47 +46,96 @@
<section class="space-y-4">
<h2 class="h2">Styling</h2>
<p>
Use the <code class="code">stroke</code> <code class="code">meter</code> or <code class="code">track</code>properties to style the
radial.
Use the <code class="code">meter</code>, or <code class="code">track</code>, <code class="code">stroke</code>,
<code class="code">strokeLinecap</code> properties to style the radial.
</p>
<DocsPreview background="neutral">
<svelte:fragment slot="preview">
<div class="w-full grid grid-cols-2 sm:grid-cols-3 lg:grid-cols-6 gap-2 text-center">
<div class="p-4 space-y-2">
<ProgressRadial stroke={strokeProps.value} meter="stroke-primary-500" track="stroke-primary-500/30" width="w-full" />
<ProgressRadial
stroke={strokeProps.value}
meter="stroke-primary-500"
track="stroke-primary-500/30"
width="w-full"
{strokeLinecap}
value={50}
/>
<p>Primary</p>
</div>
<div class="p-4 space-y-2">
<ProgressRadial stroke={strokeProps.value} meter="stroke-secondary-500" track="stroke-secondary-500/30" width="w-full" />
<ProgressRadial
stroke={strokeProps.value}
meter="stroke-secondary-500"
track="stroke-secondary-500/30"
width="w-full"
{strokeLinecap}
value={50}
/>
<p>Secondary</p>
</div>
<div class="p-4 space-y-2">
<ProgressRadial stroke={strokeProps.value} meter="stroke-tertiary-500" track="stroke-tertiary-500/30" width="w-full" />
<ProgressRadial
stroke={strokeProps.value}
meter="stroke-tertiary-500"
track="stroke-tertiary-500/30"
width="w-full"
{strokeLinecap}
value={50}
/>
<p>Tertiary</p>
</div>
<div class="p-4 space-y-2">
<ProgressRadial stroke={strokeProps.value} meter="stroke-success-500" track="stroke-success-500/30" width="w-full" />
<ProgressRadial
stroke={strokeProps.value}
meter="stroke-success-500"
track="stroke-success-500/30"
width="w-full"
{strokeLinecap}
value={50}
/>
<p>Success</p>
</div>
<div class="p-4 space-y-2">
<ProgressRadial stroke={strokeProps.value} meter="stroke-warning-500" track="stroke-warning-500/30" width="w-full" />
<ProgressRadial
stroke={strokeProps.value}
meter="stroke-warning-500"
track="stroke-warning-500/30"
width="w-full"
{strokeLinecap}
value={50}
/>
<p>Warning</p>
</div>
<div class="p-4 space-y-2">
<ProgressRadial stroke={strokeProps.value} meter="stroke-error-500" track="stroke-error-500/30" width="w-full" />
<ProgressRadial
stroke={strokeProps.value}
meter="stroke-error-500"
track="stroke-error-500/30"
width="w-full"
{strokeLinecap}
value={50}
/>
<p>Error</p>
</div>
</div>
</svelte:fragment>
<svelte:fragment slot="footer">
<div class="w-48 mx-auto">
<input type="range" min="20" max={strokeProps.max} step={strokeProps.step} bind:value={strokeProps.value} />
<div class="flex justify-between items-center gap-4">
<div class="w-60">
<input type="range" min="20" max={strokeProps.max} step={strokeProps.step} bind:value={strokeProps.value} />
</div>
<select bind:value={strokeLinecap} class="select w-auto">
{#each ['butt', 'round', 'square'] as v}
<option value={v}>{v}</option>
{/each}
</select>
</div>
</svelte:fragment>
<svelte:fragment slot="source">
<CodeBlock
language="html"
code={`<ProgressRadial ... stroke={${strokeProps.value}} meter="stroke-primary-500" track="stroke-primary-500/30" />`}
code={`<ProgressRadial ... stroke={${strokeProps.value}} meter="stroke-primary-500" track="stroke-primary-500/30" strokeLinecap={${strokeLinecap}} />`}
/>
</svelte:fragment>
</DocsPreview>
Expand Down