Skip to content

Improve prop validation with descriptive warnings in Carousel component #532

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 1 commit into from
Oct 8, 2025
Merged

Improve prop validation with descriptive warnings in Carousel component #532

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
33 changes: 19 additions & 14 deletions src/components/Carousel/carouselProps.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,11 @@ export const carouselProps = {
breakpointMode: {
default: DEFAULT_CONFIG.breakpointMode,
validator(value: BreakpointMode) {
return BREAKPOINT_MODE_OPTIONS.includes(value)
const isValid = BREAKPOINT_MODE_OPTIONS.includes(value)
if (!isValid) {
console.warn(`[vue3-carousel]: Invalid breakpointMode "${value}". Allowed values: ${BREAKPOINT_MODE_OPTIONS.join(', ')}`)
}
return isValid
},
},
clamp: {
Expand All @@ -47,20 +51,13 @@ export const carouselProps = {
type: String as PropType<Dir>,
default: DEFAULT_CONFIG.dir,
validator(value: Dir, props: { height?: string }) {
// The value must match one of these strings
if (!DIR_OPTIONS.includes(value)) {
console.warn(`[vue3-carousel]: Invalid dir "${value}". Allowed values: ${DIR_OPTIONS.join(', ')}`)
return false
}

const normalizedDir =
value in DIR_MAP ? DIR_MAP[value as NonNormalizedDir] : (value as NormalizedDir)
if (
['ttb', 'btt'].includes(normalizedDir) &&
(!props.height || props.height === 'auto')
) {
console.warn(
`[vue3-carousel]: The dir "${value}" is not supported with height "auto".`
)
const normalizedDir = value in DIR_MAP ? DIR_MAP[value as NonNormalizedDir] : (value as NormalizedDir)
if (["ttb", "btt"].includes(normalizedDir) && (!props.height || props.height === "auto")) {
console.warn(`[vue3-carousel]: The dir "${value}" is not supported with height "auto".`)
}
return true
},
Expand Down Expand Up @@ -139,14 +136,22 @@ export const carouselProps = {
type: String as PropType<SlideEffect>,
default: DEFAULT_CONFIG.slideEffect,
validator(value: SlideEffect) {
return SLIDE_EFFECTS.includes(value)
const isValid = SLIDE_EFFECTS.includes(value)
if (!isValid) {
console.warn(`[vue3-carousel]: Invalid slideEffect "${value}". Allowed values: ${SLIDE_EFFECTS.join(', ')}`)
}
return isValid
},
},
// control snap position alignment
snapAlign: {
default: DEFAULT_CONFIG.snapAlign,
validator(value: SnapAlign) {
return SNAP_ALIGN_OPTIONS.includes(value)
const isValid = SNAP_ALIGN_OPTIONS.includes(value)
if (!isValid) {
console.warn(`[vue3-carousel]: Invalid snapAlign "${value}". Allowed values: ${SNAP_ALIGN_OPTIONS.join(', ')}`)
}
return isValid
},
},
// toggle touch dragging
Expand Down