Skip to content

Add support for custom colors to FwbProgress and FwbSpinner #393

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.

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
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
17 changes: 9 additions & 8 deletions docs/components/progress.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,15 @@ You can also apply color.
```vue
<template>
<div class="grid gap-2">
<fwb-progress :progress="12.5" label="Default" />
<fwb-progress :progress="25" color="dark" label="Dark" />
<fwb-progress :progress="37.5" color="blue" label="Blue" />
<fwb-progress :progress="50" color="red" label="Red" />
<fwb-progress :progress="62.5" color="green" label="Green" />
<fwb-progress :progress="75" color="yellow" label="Yellow" />
<fwb-progress :progress="87.5" color="indigo" label="Indigo" />
<fwb-progress :progress="100" color="purple" label="Purple" />
<fwb-progress :progress="11" label="Default" />
<fwb-progress :progress="22" color="dark" label="Dark" />
<fwb-progress :progress="33" color="blue" label="Blue" />
<fwb-progress :progress="44" color="red" label="Red" />
<fwb-progress :progress="55" color="green" label="Green" />
<fwb-progress :progress="66" color="yellow" label="Yellow" />
<fwb-progress :progress="77" color="indigo" label="Indigo" />
<fwb-progress :progress="88" color="purple" label="Purple" />
<fwb-progress :progress="99" color="#3fb984" label="Custom color" />
</div>
</template>

Expand Down
21 changes: 13 additions & 8 deletions docs/components/progress/examples/FwbProgressExampleColor.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,47 @@
<div class="vp-raw grid gap-2">
<fwb-progress
label="Default"
:progress="12.5"
:progress="11"
/>
<fwb-progress
color="dark"
label="Dark"
:progress="25"
:progress="22"
/>
<fwb-progress
color="blue"
label="Blue"
:progress="37.5"
:progress="33"
/>
<fwb-progress
color="red"
label="Red"
:progress="50"
:progress="44"
/>
<fwb-progress
color="green"
label="Green"
:progress="62.5"
:progress="55"
/>
<fwb-progress
color="yellow"
label="Yellow"
:progress="75"
:progress="66"
/>
<fwb-progress
color="indigo"
label="Indigo"
:progress="87.5"
:progress="77"
/>
<fwb-progress
color="purple"
label="Purple"
:progress="100"
:progress="88"
/>
<fwb-progress
color="#3fb984"
label="Custom color"
:progress="99"
/>
</div>
</template>
Expand Down
1 change: 1 addition & 0 deletions docs/components/spinner.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ import { FwbSpinner } from 'flowbite-vue'
<fwb-spinner color="red" />
<fwb-spinner color="white" />
<fwb-spinner color="yellow" />
<fwb-spinner color="#3fb984" /> <!-- Custom color -->
</template>

<script setup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<fwb-spinner color="red" />
<fwb-spinner color="white" />
<fwb-spinner color="yellow" />
<fwb-spinner color="#3fb984" />
</div>
</template>

Expand Down
7 changes: 6 additions & 1 deletion src/components/FwbProgress/FwbProgress.vue
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
<div class="mb-1 flex justify-between">
<span
:class="outsideLabelClasses"
:style="customColor ? { color: customColor } : {}"
class="text-base font-medium"
>{{ label }}</span>
<span
v-if="labelProgress && labelPosition === 'outside'"
:class="outsideLabelClasses"
:style="customColor ? { color: customColor } : {}"
class="text-sm font-medium"
>{{ progress }}%</span>
</div>
Expand All @@ -19,7 +21,9 @@
>
<div
:class="innerClasses"
:style="{ width: progress + '%' }"
:style="customColor
? { width: progress + '%', backgroundColor: customColor }
: { width: progress + '%' }"
class="rounded-full p-0.5 text-center font-medium text-blue-100"
>
<template v-if="labelProgress && labelPosition === 'inside'">
Expand Down Expand Up @@ -59,5 +63,6 @@ const {
innerClasses,
outerClasses,
outsideLabelClasses,
customColor,
} = useProgressClasses(toRefs(props))
</script>
17 changes: 13 additions & 4 deletions src/components/FwbProgress/composables/useProgressClasses.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import classNames from 'classnames'
import { computed, type Ref } from 'vue'

import type { ProgressLabelPosition, ProgressSize, ProgressVariant } from '../types'
import type { CustomColor, ProgressLabelPosition, ProgressSize, ProgressVariant } from '../types'

const barColorClasses: Record<ProgressVariant, string> = {
default: 'bg-blue-600 dark:bg-blue-600',
Expand Down Expand Up @@ -38,10 +38,18 @@
labelPosition: Ref<ProgressLabelPosition>
}

export function useProgressClasses (props: UseProgressClassesProps): { innerClasses: Ref<string>, outerClasses: Ref<string>, outsideLabelClasses: Ref<string> } {
export function useProgressClasses (props: UseProgressClassesProps): {
innerClasses: Ref<string>,

Check failure on line 42 in src/components/FwbProgress/composables/useProgressClasses.ts

View workflow job for this annotation

GitHub Actions / lint (18.x)

Unexpected separator (,)
outerClasses: Ref<string>,

Check failure on line 43 in src/components/FwbProgress/composables/useProgressClasses.ts

View workflow job for this annotation

GitHub Actions / lint (18.x)

Unexpected separator (,)
outsideLabelClasses: Ref<string>,

Check failure on line 44 in src/components/FwbProgress/composables/useProgressClasses.ts

View workflow job for this annotation

GitHub Actions / lint (18.x)

Unexpected separator (,)
customColor: Ref<CustomColor | null>
} {
const customColor = computed(() => {
return props.color.value as CustomColor
})
const bindClasses = computed(() => {
return classNames(
barColorClasses[props.color.value],
customColor.value ? '' : barColorClasses[props.color.value],
progressSizeClasses[props.size.value],
)
})
Expand All @@ -51,7 +59,7 @@
)
})
const outsideLabelClasses = computed(() => {
return classNames(
return customColor.value ? '' : classNames(

Check failure on line 62 in src/components/FwbProgress/composables/useProgressClasses.ts

View workflow job for this annotation

GitHub Actions / lint (18.x)

Expected newline between consequent and alternate of ternary expression

Check failure on line 62 in src/components/FwbProgress/composables/useProgressClasses.ts

View workflow job for this annotation

GitHub Actions / lint (18.x)

Expected newline between test and consequent of ternary expression
outsideTextColorClasses[props.color.value],
)
})
Expand All @@ -60,5 +68,6 @@
innerClasses: bindClasses,
outerClasses,
outsideLabelClasses,
customColor,
}
}
3 changes: 2 additions & 1 deletion src/components/FwbProgress/types.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export type ProgressLabelPosition = 'inside' | 'outside' | 'none'
export type ProgressSize = 'sm' | 'md' | 'lg' | 'xl'
export type ProgressVariant = 'default' | 'dark' | 'green' | 'red' | 'yellow' | 'purple' | 'blue' | 'indigo'
export type CustomColor = (`#${string}` & {})
export type ProgressVariant = 'default' | 'dark' | 'green' | 'red' | 'yellow' | 'purple' | 'blue' | 'indigo' | CustomColor
5 changes: 3 additions & 2 deletions src/components/FwbSpinner/FwbSpinner.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<template>
<svg
:class="spinnerClasses"
:style="customColor ? { '--custom-fill': customColor } : {}"
fill="none"
role="status"
viewBox="0 0 100 101"
Expand All @@ -12,7 +13,7 @@
/>
<path
d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z"
fill="currentFill"
:fill="customColor || 'currentFill'"
/>
</svg>
</template>
Expand All @@ -34,5 +35,5 @@ const props = withDefaults(defineProps<ISpinnerProps>(), {
size: '4',
})

const { spinnerClasses } = useSpinnerClasses(toRefs(props))
const { spinnerClasses, customColor } = useSpinnerClasses(toRefs(props))
</script>
9 changes: 6 additions & 3 deletions src/components/FwbSpinner/composables/useSpinnerClasses.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,12 @@ export type UseSpinnerClassesProps = {
size: Ref<SpinnerSize>
}

export function useSpinnerClasses (props: UseSpinnerClassesProps): { spinnerClasses: Ref<string> } {
export function useSpinnerClasses (props: UseSpinnerClassesProps): { spinnerClasses: Ref<string>, customColor: Ref<string | null> } {
const sizeClasses = computed(() => sizes[props.size.value])
const colorClasses = computed(() => colors[props.color.value])

const colorClasses = computed(() => colors[props.color.value as SpinnerColor] ?? '')
const customColor = computed(() => colorClasses.value ? null : (props.color.value as string))

const bgColorClasses = computed(() => 'text-gray-200 dark:text-gray-600')
const animateClasses = computed(() => 'animate-spin')
const spinnerClasses = computed(() => classNames(
Expand All @@ -50,5 +53,5 @@ export function useSpinnerClasses (props: UseSpinnerClassesProps): { spinnerClas
sizeClasses.value,
))

return { spinnerClasses }
return { spinnerClasses, customColor }
}
3 changes: 2 additions & 1 deletion src/components/FwbSpinner/types.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export type SpinnerColor = 'blue' | 'gray' | 'green' | 'red' | 'yellow' | 'pink' | 'purple' | 'white'
type CustomColor = (`#${string}` & {})
export type SpinnerColor = 'blue' | 'gray' | 'green' | 'red' | 'yellow' | 'pink' | 'purple' | 'white' | CustomColor

export type SpinnerSize = '0' | '0.5' | '1' | '1.5' | '2' | '2.5' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12'
Loading