Project React Native Reanimated Modal
Type Aliases§
Source§type Modal
? FadeAnimationConfig
: T extends "slide"
? SlideAnimationConfig
: T extends "scale" ? ScaleAnimationConfig : never
type Modal
? FadeAnimationConfig
: T extends "slide"
? SlideAnimationConfig
: T extends "scale" ? ScaleAnimationConfig : never
Source§type Modal
type Modal
Union of all animation configuration types.
Variables§
Source§const DEFAULT
fade: FadeAnimationConfig;
scale: ScaleAnimationConfig;
slide: SlideAnimationConfig;
} = ...
const DEFAULT
fade: FadeAnimationConfig;
scale: ScaleAnimationConfig;
slide: SlideAnimationConfig;
} = ...
Default animation configurations.
Source§const DEFAULT
const DEFAULT
Default values and configurations.
Source§const DEFAULT
const DEFAULT
Default backdrop configuration.
Source§const DEFAULT
const DEFAULT
Default swipe configuration.
Source§const DEFAULT
const DEFAULT
Source§const Modal: FC<ModalProps> = ...
const Modal: FC<ModalProps> = ...
Modal component with smooth, customizable animations and gesture support. Built on top of React Native's Modal, Reanimated, and Gesture Handler.
Functions§
Source§getSlideInDirection(
animationConfig: ModalAnimationConfigUnion,
fallback?: SwipeDirection,
): SwipeDirection
getSlideInDirection(
animationConfig: ModalAnimationConfigUnion,
fallback?: SwipeDirection,
): SwipeDirection
Gets the slide-in direction from animation config.
Source§getSwipeDirections(
swipeConfig: ModalSwipeConfig,
animationConfig?: ModalAnimationConfigUnion,
fallback?: SwipeDirection | SwipeDirection[],
): SwipeDirection[]
getSwipeDirections(
swipeConfig: ModalSwipeConfig,
animationConfig?: ModalAnimationConfigUnion,
fallback?: SwipeDirection | SwipeDirection[],
): SwipeDirection[]
Extracts swipe directions from swipe config or animation config fallback.
Source§normalizeAnimationConfig(
config?: undefined | ModalAnimation | Partial<ModalAnimationConfigUnion>,
): ModalAnimationConfigUnion
normalizeAnimationConfig(
config?: undefined | ModalAnimation | Partial<ModalAnimationConfigUnion>,
): ModalAnimationConfigUnion
Normalizes animation configuration by providing defaults for missing properties.
Source§normalizeBackdropConfig(
backdrop?: ModalBackdropConfig | ReactNode,
): {
config: ModalBackdropConfig;
customRenderer?: ReactNode;
enabled: boolean;
isCustom: boolean;
}
normalizeBackdropConfig(
backdrop?: ModalBackdropConfig | ReactNode,
): {
config: ModalBackdropConfig;
customRenderer?: ReactNode;
enabled: boolean;
isCustom: boolean;
}
Normalizes backdrop configuration by providing defaults for missing properties.
Source§normalizeSwipeConfig(config?: false | ModalSwipeConfig): ModalSwipeConfig
normalizeSwipeConfig(config?: false | ModalSwipeConfig): ModalSwipeConfig
Normalizes swipe configuration by providing defaults for missing properties.
Interfaces§
- FadeAnimationConfig
Configuration for fade animation.
- ModalBackdropConfig
Configuration for modal backdrop.
- ModalProps
Props for the Modal component.
- ModalSwipeConfig
Configuration for modal swipe.
- ScaleAnimationConfig
Configuration for scale animation.
- SlideAnimationConfig
Configuration for slide animation.
Generic type for animation config based on animation type.