Skip to content

docs(slider): add JSDoc to props #17

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
matcane merged 1 commit into from
Sep 19, 2026
Merged

docs(slider): add JSDoc to props #17

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
29 changes: 28 additions & 1 deletion src/ImageComparisonSlider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,47 @@ const LINE_WIDTH = 3;

type PassThroughImageProps = Omit<ImageProps, "source" | "style" | "contentFit">;

/** Props for {@link ImageComparisonSlider}. */
export interface ImageComparisonSliderProps {
/** Revealed image */
before: ImageSource | number;

/** Background image */
after: ImageSource | number;

/** Split ratio, 0–1 */
initialPosition?: number;
contentFit?: ImageProps["contentFit"];

/** Comparison UI and gestures */
enabled?: boolean;

/** Both images */
contentFit?: ImageProps["contentFit"];

/** Image stack corners */
borderRadius?: number;

/** Root container */
style?: StyleProp<ViewStyle>;

/** Knob children */
knobContent?: ReactNode;

/** Divider line */
renderLine?: ReactNode;

/** before (expo-image, minus source / style / contentFit) */
beforeImageProps?: PassThroughImageProps;

/** after */
afterImageProps?: PassThroughImageProps;
}

/**
* Before/after image comparison slider for React Native and Expo.
*
* @see {@link ImageComparisonSliderProps}
*/
export function ImageComparisonSlider({
before,
after,
Expand Down
Loading