@sbaiahmed1/react-native-blur
Version:
React native modern blur view
75 lines • 2.62 kB
TypeScript
import React from 'react';
import type { ViewStyle, StyleProp, ColorValue } from 'react-native';
import ReactNativeProgressiveBlurView, { type BlurType, type ProgressiveBlurDirection } from './ReactNativeProgressiveBlurViewNativeComponent';
export interface ProgressiveBlurViewProps {
/**
* @description The type of blur effect to apply
*
* @default 'regular'
*/
blurType?: BlurType;
/**
* @description The maximum intensity of the blur effect (in pixels)
* This is the blur radius at the most blurred part of the gradient
*
* @default 20
*/
blurAmount?: number;
/**
* @description The number of blur interactions to perform for a smoother
* effect (1-15)
*
* @default 5
*
* @platform Android
*/
blurRounds?: number;
/**
* @description The direction of the progressive blur gradient
* - 'blurredTopClearBottom': Blur starts at top, clear at bottom
* - 'blurredBottomClearTop': Blur starts at bottom, clear at top
* - 'blurredCenterClearTopAndBottom': Blur peaks at center, clear at both edges
*
* @default 'blurredTopClearBottom'
*/
direction?: ProgressiveBlurDirection;
/**
* @description The offset where the gradient starts (0.0 to 1.0)
* 0.0 means the gradient starts immediately
* 1.0 means the gradient is delayed to the end
*
* @default 0.0
*/
startOffset?: number;
/**
* @description Fallback color when reduced transparency is enabled
*
* @default '#FFFFFF'
*
* @platform iOS
*/
reducedTransparencyFallbackColor?: string;
/**
* @description The overlay color to apply on top of the blur effect
*
* @default undefined
*/
overlayColor?: ColorValue;
/**
* @description style object for the progressive blur view
*
* @default undefined
*/
style?: StyleProp<ViewStyle>;
/**
* @description Child components to render inside the progressive blur view
*
* @default undefined
*/
children?: React.ReactNode;
}
/** Ref to the underlying native progressive blur view. */
export type ProgressiveBlurViewRef = React.ComponentRef<typeof ReactNativeProgressiveBlurView>;
export declare const ProgressiveBlurView: React.NamedExoticComponent<ProgressiveBlurViewProps & React.RefAttributes<React.Component<import("./ReactNativeProgressiveBlurViewNativeComponent").NativeProps, {}, any> & import("react-native").ReactNativeElement>>;
export default ProgressiveBlurView;
//# sourceMappingURL=ProgressiveBlurView.d.ts.map