Skip to content
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

Jump to bottom

Add coverScreen prop #145

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+37 −20
Open

Add coverScreen prop #145

Show file tree
Hide file tree
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
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ const styles = StyleSheet.create({
| keyboardVerticalOffset | number | undefined | keyboardVerticalOffset for iOS |
| verticalButtons | bool | false | Renders button vertically |
| useNativeDriver | bool | false | Defines if animations should use native driver |
| coverScreen | bool | true | Whether an RN modal will be used to cover the entire screen |

### Dialog.Input props

Expand All @@ -191,14 +192,14 @@ const styles = StyleSheet.create({

### Dialog.CodeInput props

| Name | Type | Default | Description |
| --------------------------- | ------ | --------- | ------------------------------------------------------------ |
| wrapperStyle | any | undefined | The style applied to the input wrapper View |
| digitContainerStyle | any | undefined | The style applied to the digit container View |
| digitContainerFocusedStyle | any | undefined | The style applied to the digit container View when in focus |
| digitStyle | any | undefined | The style applied to the digit text |
| codeLength | number | 4 | The total number of digits |
| onCodeChange | func | undefined | Called when the input changed |
| Name | Type | Default | Description |
| -------------------------- | ------ | --------- | ----------------------------------------------------------- |
| wrapperStyle | any | undefined | The style applied to the input wrapper View |
| digitContainerStyle | any | undefined | The style applied to the digit container View |
| digitContainerFocusedStyle | any | undefined | The style applied to the digit container View when in focus |
| digitStyle | any | undefined | The style applied to the digit text |
| codeLength | number | 4 | The total number of digits |
| onCodeChange | func | undefined | Called when the input changed |

`Dialog.CodeInput` also accepts all the React-Native's `TextInput` component props.

Expand Down
1 change: 1 addition & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions src/Container.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ export type DialogContainerProps = PropsWithChildren<{
onRequestClose?: () => void;
keyboardVerticalOffset?: number;
useNativeDriver?: boolean;
coverScreen?: boolean;
}>;

const DialogContainer: React.FC<DialogContainerProps> = (props) => {
Expand Down
38 changes: 26 additions & 12 deletions src/Modal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
StyleProp,
StyleSheet,
TouchableWithoutFeedback,
View,
ViewStyle,
} from "react-native";

Expand Down Expand Up @@ -63,6 +64,7 @@ export interface ModalProps extends ReactNativeModalProps {
visible?: boolean;
contentStyle?: StyleProp<ViewStyle>;
useNativeDriver?: boolean;
coverScreen?: boolean;
}

interface ModalState {
Expand All @@ -76,6 +78,7 @@ export class Modal extends Component<ModalProps, ModalState> {
onHide: () => null,
visible: false,
useNativeDriver: false,
coverScreen: true,
};

state: ModalState = {
Expand Down Expand Up @@ -139,6 +142,7 @@ export class Modal extends Component<ModalProps, ModalState> {
children,
onBackdropPress,
contentStyle,
coverScreen,
...otherProps
} = this.props;
const { currentAnimation, visible } = this.state;
Expand Down Expand Up @@ -176,13 +180,8 @@ export class Modal extends Component<ModalProps, ModalState> {
}),
};

return (
<ReactNativeModal
transparent
animationType="none"
{...otherProps}
visible={visible}
>
const content = (
<>
<TouchableWithoutFeedback onPress={onBackdropPress}>
<Animated.View style={[styles.backdrop, backdropAnimatedStyle]} />
</TouchableWithoutFeedback>
Expand All @@ -201,18 +200,33 @@ export class Modal extends Component<ModalProps, ModalState> {
{children}
</Animated.View>
)}
</>
);

if (!coverScreen && visible) {
return (
<View pointerEvents="box-none" style={StyleSheet.absoluteFill}>
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know, in the other thread I suggested to just provide a coverScreen prop like we're doing in react-native-modal. Still, I think an even better approach for the maintainability of the project would be to instead allow providing a CustomModalComponent props that we'll just swap with ReactNativeModal below, if provided.
Why? Because with the current approach in the future people will also require something like coverScreenWrapperProps to inject here, and so on, making the surface area of this API even bigger.
The drawback of the CustomModalComponent approach is that users will need to maintain the wrapper (so line 208 to 210 in their app — but I'm 100% OK with it given that it's not something that I want to/can maintain within react-native-dialog :/
Hope it makes sense.

{content}
</View>
);
}

return (
<ReactNativeModal
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically, following what I'm saying above, you can replace ReactNativeModal here with ModalComponent, which is a variable defined like this:

const ModalComponent = props.CustomModalComponent || ReactNativeModal;

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha. Can do, I'll update the PR shortly.

transparent
animationType="none"
{...otherProps}
visible={visible}
>
{content}
</ReactNativeModal>
);
}
}

const styles = StyleSheet.create({
backdrop: {
position: "absolute",
top: 0,
bottom: 0,
left: 0,
right: 0,
...StyleSheet.absoluteFillObject,
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL :)

backgroundColor: "black",
opacity: 0,
},
Expand Down