Skip to content

docs(BProgress): Parity pass #2689

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

Merged
merged 2 commits into from
May 11, 2025
Merged

docs(BProgress): Parity pass #2689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c4813e
docs: refactor examples and bring docs to parity
dwgray May 9, 2025
6c7b390
docs(BProgress): Fill out component reference
dwgray May 9, 2025
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
51 changes: 23 additions & 28 deletions apps/docs/src/data/components/progress.data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type {BvnComponentProps} from 'bootstrap-vue-next'
import type {ComponentReference, PropertyReference} from '../../types'
import {buildCommonProps, pick} from '../../utils'

export default {
load: (): ComponentReference[] => [
Expand All @@ -11,55 +12,52 @@ export default {
animated: {
type: 'boolean',
default: undefined,
},
bgVariant: {
type: 'ColorVariant | null',
default: undefined,
description: "Enable the animated background. Also automatically sets 'striped'",
},
height: {
type: 'string',
default: undefined,
description:
'Override the default height by specifying a CSS height value (including units)',
},
max: {
type: 'Numberish',
default: 100,
description: 'Set the maximum value',
},
precision: {
type: 'Numberish',
default: undefined,
description: 'The number of digits after the decimal to round the value to',
},
showProgress: {
type: 'boolean',
default: undefined,
description: 'Displays the current progress value as a percentage',
},
showValue: {
type: 'boolean',
default: undefined,
description: 'Displays the current progress value',
},
striped: {
type: 'boolean',
default: undefined,
},
textVariant: {
type: 'TextColorVariant | null',
default: undefined,
description: 'Enable the striped background',
},
value: {
type: 'Numberish',
default: undefined,
description: 'The current value of the progress bar',
},
variant: {
type: 'ColorVariant | null',
default: undefined,
},
...pick(buildCommonProps(), ['bgVariant', 'textVariant', 'variant']),
} satisfies Record<keyof BvnComponentProps['BProgress'], PropertyReference>,
},
emits: [],
slots: [
{
description: '',
name: 'default',
scope: [],
description: 'Content (progress bars) to place in the progress element',
},
],
},
Expand All @@ -71,55 +69,52 @@ export default {
animated: {
type: 'boolean',
default: false,
},
bgVariant: {
type: 'ColorVariant | null',
default: null,
description: "Enable the animated background. Also automatically sets 'striped'",
},
label: {
type: 'string',
default: undefined,
description: 'Text string to explicitly set the label as',
},
max: {
type: 'Numberish',
default: undefined,
description: 'Set the maximum value',
},
precision: {
type: 'Numberish',
default: 0,
description: 'The number of digits after the decimal to round the value to',
},
showProgress: {
type: 'boolean',
default: false,
description: 'Displays the current progress value as a percentage',
},
showValue: {
type: 'boolean',
default: false,
description: 'Displays the current progress value',
},
striped: {
type: 'boolean',
default: false,
},
textVariant: {
type: 'TextColorVariant | null',
default: null,
description: 'Enable the striped background',
},
value: {
type: 'Numberish',
default: 0,
description: 'The current value of the progress bar',
},
variant: {
type: 'ColorVariant | null',
default: null,
},
...pick(buildCommonProps(), ['bgVariant', 'textVariant', 'variant']),
} satisfies Record<keyof BvnComponentProps['BProgressBar'], PropertyReference>,
},
emits: [],
slots: [
{
description: '',
name: 'default',
scope: [],
description:
'Content to place in the progress bar. Overrides the `label`, `show-progress` and `show-value` props',
},
],
},
Expand Down
8 changes: 8 additions & 0 deletions apps/docs/src/docs/components/demo/ProgressAnimated.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<template>
<!-- #region template -->
<BProgress variant="success" :value="25" striped animated />
<BProgress class="mt-3" variant="info" :value="50" striped animated />
<BProgress class="mt-3" variant="warning" :value="75" striped animated />
<BProgress class="mt-3" variant="danger" :value="100" striped animated />
<!-- #endregion template -->
</template>
8 changes: 8 additions & 0 deletions apps/docs/src/docs/components/demo/ProgressBackgrounds.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<template>
<!-- #region template -->
<BProgress variant="success" :value="25" />
<BProgress class="mt-3" variant="info" :value="50" />
<BProgress class="mt-3" variant="warning" :value="75" />
<BProgress class="mt-3" variant="danger" :value="100" />
<!-- #endregion template -->
</template>
9 changes: 9 additions & 0 deletions apps/docs/src/docs/components/demo/ProgressBasic.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<template>
<!-- #region template -->
<BProgress :value="0" />
<BProgress class="mt-3" :value="25" />
<BProgress class="mt-3" :value="50" />
<BProgress class="mt-3" :value="75" />
<BProgress class="mt-3" :value="100" />
<!-- #endregion template -->
</template>
17 changes: 17 additions & 0 deletions apps/docs/src/docs/components/demo/ProgressCustomLabels.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<template>
<!-- #region template -->
<h5>Custom label via default slot</h5>
<BProgress :max="50" height="2rem">
<BProgressBar :value="33.333333">
<span
>Progress: <strong>{{ (33.333333).toFixed(2) }} / {{ 50 }}</strong></span
>
</BProgressBar>
</BProgress>

<h5 class="mt-3">Custom label via property</h5>
<BProgress :max="50">
<BProgressBar :value="33.333333" :label="`${((33.333333 / 50) * 100).toFixed(2)}%`" />
</BProgress>
<!-- #endregion template -->
</template>
6 changes: 6 additions & 0 deletions apps/docs/src/docs/components/demo/ProgressHeight.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<template>
<!-- #region template -->
<BProgress :value="25" height="1px" />
<BProgress class="mt-3" :value="25" height="20px" />
<!-- #endregion template -->
</template>
14 changes: 14 additions & 0 deletions apps/docs/src/docs/components/demo/ProgressLabels.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<template>
<!-- #region template -->
<h5>No label</h5>
<BProgress :value="33.3333" :max="50" />
<h5>Value label</h5>
<BProgress :value="33.3333" :max="50" show-value />
<h5>Progress label</h5>
<BProgress :value="33.3333" :max="50" show-progress />
<h5>Value label with precision</h5>
<BProgress :value="33.3333" :max="50" :precision="2" show-value />
<h5>Progress label with precision</h5>
<BProgress :value="33.3333" :max="50" :precision="2" show-progress />
<!-- #endregion template -->
</template>
9 changes: 9 additions & 0 deletions apps/docs/src/docs/components/demo/ProgressMultipleBars.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<template>
<!-- #region template -->
<BProgress>
<BProgressBar :value="15" />
<BProgressBar :value="30" variant="success" />
<BProgressBar :value="20" variant="info" />
</BProgress>
<!-- #endregion template -->
</template>
9 changes: 9 additions & 0 deletions apps/docs/src/docs/components/demo/ProgressStriped.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<template>
<!-- #region template -->
<BProgress striped :value="10" />
<BProgress striped class="mt-3" variant="success" :value="25" />
<BProgress striped class="mt-3" variant="info" :value="50" />
<BProgress striped class="mt-3" variant="warning" :value="75" />
<BProgress striped class="mt-3" variant="danger" :value="100" />
<!-- #endregion template -->
</template>
11 changes: 11 additions & 0 deletions apps/docs/src/docs/components/demo/ProgressWidth.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<template>
<!-- #region template -->
<h5>Default width</h5>
<BProgress :value="75" class="mb-3" />

<h5>Custom widths</h5>
<BProgress :value="75" class="w-75 mb-2" />
<BProgress :value="75" class="w-50 mb-2" />
<BProgress :value="75" class="w-25" />
<!-- #endregion template -->
</template>
Loading