react-native-ui-lib
Version:
<p align="center"> <img src="https://user-images.githubusercontent.com/1780255/105469025-56759000-5ca0-11eb-993d-3568c1fd54f4.png" height="250px" style="display:block"/> </p> <p align="center">UI Toolset & Components Library for React Native</p> <p a
74 lines (73 loc) • 2.25 kB
TypeScript
import React from 'react';
import { StyleProp, ViewStyle, ModalPropsIOS, AccessibilityProps } from 'react-native';
import { AlignmentModifiers } from '../../commons/modifiers';
import { ModalProps } from '../modal';
import { PanningDirections } from '../panningViews/panningProvider';
interface RNPartialProps extends Pick<ModalPropsIOS, 'supportedOrientations'>, Pick<AccessibilityProps, 'accessibilityLabel'> {
}
export interface DialogProps extends AlignmentModifiers, RNPartialProps {
/**
* Control visibility of the dialog
*/
visible?: boolean;
/**
* Dismiss callback for when clicking on the background
*/
onDismiss?: (props?: any) => void;
/**
* Whether or not to ignore background press
*/
ignoreBackgroundPress?: boolean;
/**
* The color of the overlay background
*/
overlayBackgroundColor?: string;
/**
* The dialog width (default: 90%)
*/
width?: string | number;
/**
* The dialog height (default: undefined)
*/
height?: string | number | null;
/**
* The direction of the allowed pan (default is DOWN).
* Types: UP, DOWN, LEFT and RIGHT (using PanningProvider.Directions.###).
* Pass null to remove pan.
*/
panDirection?: PanningDirections;
/**
* Whether or not to handle SafeArea
*/
useSafeArea?: boolean;
/**
* Called once the dialog has been dismissed completely
*/
onDialogDismissed?: (props: any) => void;
/**
* If this is added only the header will be pannable;
* this allows for scrollable content (the children of the dialog)
* props are transferred to the renderPannableHeader
*/
renderPannableHeader?: (props: any) => JSX.Element;
/**
* The props that will be passed to the pannable header
*/
pannableHeaderProps?: any;
/**
* Additional props for the modal.
*/
modalProps?: ModalProps;
/**
* The Dialog`s container style
*/
containerStyle?: StyleProp<ViewStyle>;
/**
* Used as a testing identifier
*/
testID?: string;
}
declare const _default: React.ComponentClass<DialogProps & {
useCustomTheme?: boolean | undefined;
}, any>;
export default _default;