bootstrap-rn 0.3.3 → 0.3.4

package/src/components/modal/{Modal.js → Modal.tsx}

@@ -1,235 +1,233 @@
-import React, { useRef } from 'react';
-import { Modal as BaseModal, SafeAreaView } from 'react-native';
-import PropTypes from 'prop-types';
-import { OverlayProvider } from '@react-native-aria/overlays';
-import StyleSheet from '../../style/StyleSheet';
-import { getStyles } from '../../utils';
-import css from '../../style/css';
-import ScrollView from '../ScrollView';
-import View from '../View';
-import BackdropHandler from '../helpers/BackdropHandler';
-import useModal from './useModal';
-import ModalContext from './ModalContext';
-import ModalHeader from './ModalHeader';
-import ModalTitle from './ModalTitle';
-import ModalBody from './ModalBody';
-import ModalFooter from './ModalFooter';
-
-const MODAL_SIZES = ['sm', 'lg', 'xl'];
-
-const propTypes = {
-  children: PropTypes.node.isRequired,
-  visible: PropTypes.bool.isRequired,
-  size: PropTypes.oneOf(MODAL_SIZES),
-  backdrop: PropTypes.oneOfType([PropTypes.bool, PropTypes.oneOf(['static'])]),
-  scrollable: PropTypes.bool,
-  centered: PropTypes.bool,
-  onToggle: PropTypes.func.isRequired,
-  // eslint-disable-next-line react/forbid-prop-types
-  style: PropTypes.any,
-  // eslint-disable-next-line react/forbid-prop-types
-  contentContainerStyle: PropTypes.any,
-  // eslint-disable-next-line react/forbid-prop-types
-  dialogStyle: PropTypes.any,
-  // eslint-disable-next-line react/forbid-prop-types
-  contentStyle: PropTypes.any,
-  // eslint-disable-next-line react/forbid-prop-types
-  textStyle: PropTypes.any,
-  // eslint-disable-next-line react/forbid-prop-types
-  dialogTextStyle: PropTypes.any,
-  // eslint-disable-next-line react/forbid-prop-types
-  contentTextStyle: PropTypes.any,
-};
-
-const styles = StyleSheet.create({
-  '.modal': css`
-    position: absolute; // fixed;
-    top: 0;
-    left: 0;
-    z-index: $zindex-modal;
-    // display: none;
-    width: 100%;
-    height: 100%;
-    // overflow-x: hidden;
-    // overflow-y: auto;
-    // Prevent Chrome on Windows from adding a focus outline. For details, see
-    // https://github.com/twbs/bootstrap/pull/10951.
-    @include platform(web) {
-      outline-width: 0; // outline: 0;
-    }
-    // We deliberately don't use "-webkit-overflow-scrolling: touch;" due to a
-    // gnarly iOS Safari bug: https://bugs.webkit.org/show_bug.cgi?id=158342
-    // See also https://github.com/twbs/bootstrap/issues/17695
-  `,
-  '.modal-dialog': css`
-    position: relative;
-    width: auto;
-    margin: $modal-dialog-margin;
-    // allow clicks to pass through for custom click handling to close modal
-    pointer-events: auto; // pointer-events: none;
-
-    @include media-breakpoint-up(sm) {
-      width: 100%; // added for bootstrap-rn
-      max-width: $modal-md;
-      margin: $modal-dialog-margin-y-sm-up auto;
-    }
-  `,
-  '.modal-dialog-scrollable': css`
-    flex-shrink: 1; // added for bootstrap-rn
-    // height: calc(100% - var(--#{$prefix}modal-margin) * 2);
-  `,
-  '.modal-dialog-scrollable .modal-content': css`
-    max-height: 100%;
-    overflow: hidden;
-  `,
-  '.modal-dialog-centered': css`
-    display: flex;
-    // align-items: center;
-    // min-height: calc(100% - var(--#{$prefix}modal-margin) * 2);
-  `,
-  '.modal-content': css`
-    position: relative;
-    display: flex;
-    flex-direction: column;
-    width: 100%; // Ensure ".modal-content" extends the full width of the parent ".modal-dialog"
-    // counteract the pointer-events: none; in the .modal-dialog
-    pointer-events: auto;
-    background-color: $modal-content-bg;
-    // background-clip: padding-box;
-    border: $modal-content-border-width solid $modal-content-border-color;
-    border-radius: $modal-content-border-radius;
-    // @include box-shadow($modal-content-box-shadow-xs);
-    // Remove focus outline from opened modal
-    // outline: 0;
-
-    @include media-breakpoint-up(sm) {
-      // @include box-shadow($modal-content-box-shadow-sm-up);
-    }
-  `,
-  '.modal-content --text': css`
-    color: $modal-content-color;
-  `,
-  '.modal-backdrop': css`
-    position: absolute;
-    top: 0;
-    left: 0;
-    z-index: $zindex-modal-backdrop;
-    width: 100%;
-    height: 100%;
-    background-color: $modal-backdrop-bg;
-    opacity: $modal-backdrop-opacity;
-  `,
-  '.modal-sm': css`
-    @include media-breakpoint-up(sm) {
-      max-width: $modal-sm;
-    }
-  `,
-  '.modal-lg': css`
-    @include media-breakpoint-up(lg) {
-      max-width: $modal-lg;
-    }
-  `,
-  '.modal-xl': css`
-    @include media-breakpoint-up(lg) {
-      max-width: $modal-lg;
-    }
-    @include media-breakpoint-up(xl) {
-      max-width: $modal-xl;
-    }
-  `,
-});
-
-const Modal = React.forwardRef((props, ref) => {
-  const {
-    children,
-    visible,
-    size,
-    backdrop = true,
-    scrollable = false,
-    centered = false,
-    onToggle: handleToggle,
-    style,
-    contentContainerStyle,
-    dialogStyle,
-    contentStyle,
-    textStyle,
-    dialogTextStyle,
-    contentTextStyle,
-    ...elementProps
-  } = props;
-
-  const dialogRef = useRef();
-
-  const modal = useModal(visible, scrollable);
-
-  const backdropClasses = getStyles(styles, ['.modal-backdrop']);
-  const classes = getStyles(styles, ['.modal']);
-  const dialogClasses = getStyles(styles, [
-    '.modal-dialog',
-    size === 'sm' && '.modal-sm',
-    size === 'lg' && '.modal-lg',
-    size === 'xl' && '.modal-xl',
-    scrollable && '.modal-dialog-scrollable',
-    centered && '.modal-dialog-centered',
-  ]);
-  const contentClasses = getStyles(styles, [
-    '.modal-content',
-    scrollable && '.modal-dialog-scrollable .modal-content',
-  ]);
-  const contentTextClasses = getStyles(styles, ['.modal-content --text']);
-
-  // If scrollable we use a ScrollView in ModalBody, so we can use a View here.
-  const FlexView = scrollable ? View : ScrollView;
-
-  const centeredStyle = centered && { justifyContent: 'center' };
-
-  return (
-    <BaseModal transparent visible={visible} onRequestClose={handleToggle}>
-      {backdrop && <View style={backdropClasses} />}
-      <FlexView
-        {...elementProps}
-        ref={ref}
-        style={[classes, scrollable && centeredStyle, style]}
-        textStyle={textStyle}
-        contentContainerStyle={
-          scrollable
-            ? undefined
-            : [{ flexGrow: 1 }, centeredStyle, contentContainerStyle]
-        }
-      >
-        <BackdropHandler
-          dialogRef={dialogRef}
-          onClose={handleToggle}
-          backdrop={backdrop}
-        />
-        <SafeAreaView style={{ flexShrink: 1 }}>
-          <View
-            ref={dialogRef}
-            style={[dialogClasses, dialogStyle]}
-            textStyle={dialogTextStyle}
-          >
-            <View
-              style={[contentClasses, contentStyle]}
-              textStyle={[contentTextClasses, contentTextStyle]}
-            >
-              <ModalContext.Provider value={modal}>
-                <OverlayProvider>{children}</OverlayProvider>
-              </ModalContext.Provider>
-            </View>
-          </View>
-        </SafeAreaView>
-      </FlexView>
-    </BaseModal>
-  );
-});
-
-Modal.displayName = 'Modal';
-Modal.propTypes = propTypes;
-
-Modal.Context = ModalContext;
-Modal.Header = ModalHeader;
-Modal.Title = ModalTitle;
-Modal.Body = ModalBody;
-Modal.Footer = ModalFooter;
-
-export default Modal;
+import React, { useRef } from 'react';
+import { Modal as BaseModal, SafeAreaView } from 'react-native';
+import { OverlayProvider } from '@react-native-aria/overlays';
+import StyleSheet from '../../style/StyleSheet';
+import { getStyles } from '../../utils';
+import css from '../../style/css';
+import ScrollView from '../ScrollView';
+import View, { ViewProps, ViewRef } from '../View';
+import BackdropHandler from '../helpers/BackdropHandler';
+import useModal from './useModal';
+import ModalContext from './ModalContext';
+import ModalHeader from './ModalHeader';
+import ModalTitle from './ModalTitle';
+import ModalBody from './ModalBody';
+import ModalFooter from './ModalFooter';
+import { ExtendedTextStyle, ExtendedViewStyle, StyleProp } from '../../types';
+
+export interface ModalProps extends ViewProps {
+  visible: boolean;
+  size?: 'sm' | 'lg' | 'xl';
+  backdrop?: boolean | 'static';
+  scrollable?: boolean;
+  centered?: boolean;
+  onToggle: () => void;
+  contentContainerStyle?: StyleProp<ExtendedViewStyle>;
+  dialogStyle?: StyleProp<ExtendedViewStyle>;
+  contentStyle?: StyleProp<ExtendedViewStyle>;
+  dialogTextStyle?: StyleProp<ExtendedTextStyle>;
+  contentTextStyle?: StyleProp<ExtendedTextStyle>;
+}
+
+type JustifyContentValue =
+  | 'flex-start'
+  | 'flex-end'
+  | 'center'
+  | 'space-between'
+  | 'space-around'
+  | 'space-evenly';
+
+const styles = StyleSheet.create({
+  '.modal': css`
+    position: absolute; // fixed;
+    top: 0;
+    left: 0;
+    z-index: $zindex-modal;
+    // display: none;
+    width: 100%;
+    height: 100%;
+    // overflow-x: hidden;
+    // overflow-y: auto;
+    // Prevent Chrome on Windows from adding a focus outline. For details, see
+    // https://github.com/twbs/bootstrap/pull/10951.
+    @include platform(web) {
+      outline-width: 0; // outline: 0;
+    }
+    // We deliberately don't use "-webkit-overflow-scrolling: touch;" due to a
+    // gnarly iOS Safari bug: https://bugs.webkit.org/show_bug.cgi?id=158342
+    // See also https://github.com/twbs/bootstrap/issues/17695
+  `,
+  '.modal-dialog': css`
+    position: relative;
+    width: auto;
+    margin: $modal-dialog-margin;
+    // allow clicks to pass through for custom click handling to close modal
+    pointer-events: auto; // pointer-events: none;
+
+    @include media-breakpoint-up(sm) {
+      width: 100%; // added for bootstrap-rn
+      max-width: $modal-md;
+      margin: $modal-dialog-margin-y-sm-up auto;
+    }
+  `,
+  '.modal-dialog-scrollable': css`
+    flex-shrink: 1; // added for bootstrap-rn
+    // height: calc(100% - var(--#{$prefix}modal-margin) * 2);
+  `,
+  '.modal-dialog-scrollable .modal-content': css`
+    max-height: 100%;
+    overflow: hidden;
+  `,
+  '.modal-dialog-centered': css`
+    display: flex;
+    // align-items: center;
+    // min-height: calc(100% - var(--#{$prefix}modal-margin) * 2);
+  `,
+  '.modal-content': css`
+    position: relative;
+    display: flex;
+    flex-direction: column;
+    width: 100%; // Ensure ".modal-content" extends the full width of the parent ".modal-dialog"
+    // counteract the pointer-events: none; in the .modal-dialog
+    pointer-events: auto;
+    background-color: $modal-content-bg;
+    // background-clip: padding-box;
+    border: $modal-content-border-width solid $modal-content-border-color;
+    border-radius: $modal-content-border-radius;
+    // @include box-shadow($modal-content-box-shadow-xs);
+    // Remove focus outline from opened modal
+    // outline: 0;
+
+    @include media-breakpoint-up(sm) {
+      // @include box-shadow($modal-content-box-shadow-sm-up);
+    }
+  `,
+  '.modal-content --text': css`
+    color: $modal-content-color;
+  `,
+  '.modal-backdrop': css`
+    position: absolute;
+    top: 0;
+    left: 0;
+    z-index: $zindex-modal-backdrop;
+    width: 100%;
+    height: 100%;
+    background-color: $modal-backdrop-bg;
+    opacity: $modal-backdrop-opacity;
+  `,
+  '.modal-sm': css`
+    @include media-breakpoint-up(sm) {
+      max-width: $modal-sm;
+    }
+  `,
+  '.modal-lg': css`
+    @include media-breakpoint-up(lg) {
+      max-width: $modal-lg;
+    }
+  `,
+  '.modal-xl': css`
+    @include media-breakpoint-up(lg) {
+      max-width: $modal-lg;
+    }
+    @include media-breakpoint-up(xl) {
+      max-width: $modal-xl;
+    }
+  `,
+});
+
+const Modal = React.forwardRef<ViewRef, ModalProps>((props, ref) => {
+  const {
+    children,
+    visible,
+    size,
+    backdrop = true,
+    scrollable = false,
+    centered = false,
+    onToggle: handleToggle,
+    style,
+    contentContainerStyle,
+    dialogStyle,
+    contentStyle,
+    textStyle,
+    dialogTextStyle,
+    contentTextStyle,
+    ...elementProps
+  } = props;
+
+  const dialogRef = useRef(null);
+
+  const modal = useModal(visible, scrollable);
+
+  const backdropClasses = getStyles(styles, ['.modal-backdrop']);
+  const classes = getStyles(styles, ['.modal']);
+  const dialogClasses = getStyles(styles, [
+    '.modal-dialog',
+    size === 'sm' && '.modal-sm',
+    size === 'lg' && '.modal-lg',
+    size === 'xl' && '.modal-xl',
+    scrollable && '.modal-dialog-scrollable',
+    centered && '.modal-dialog-centered',
+  ]);
+  const contentClasses = getStyles(styles, [
+    '.modal-content',
+    scrollable && '.modal-dialog-scrollable .modal-content',
+  ]);
+  const contentTextClasses = getStyles(styles, ['.modal-content --text']);
+
+  // If scrollable we use a ScrollView in ModalBody, so we can use a View here.
+  const FlexView = scrollable ? View : ScrollView;
+
+  const centeredStyle = centered && {
+    justifyContent: 'center' as JustifyContentValue,
+  };
+
+  return (
+    <BaseModal transparent visible={visible} onRequestClose={handleToggle}>
+      {backdrop && <View style={backdropClasses} />}
+      <FlexView
+        {...elementProps}
+        // @ts-expect-error We need to fix it in the future.
+        ref={ref}
+        style={[classes, scrollable && centeredStyle, style]}
+        textStyle={textStyle}
+        contentContainerStyle={
+          scrollable
+            ? undefined
+            : [{ flexGrow: 1 }, centeredStyle, contentContainerStyle]
+        }
+      >
+        <BackdropHandler
+          dialogRef={dialogRef}
+          onClose={handleToggle}
+          backdrop={backdrop}
+        />
+        <SafeAreaView style={{ flexShrink: 1 }}>
+          <View
+            ref={dialogRef}
+            style={[dialogClasses, dialogStyle]}
+            textStyle={dialogTextStyle}
+          >
+            <View
+              style={[contentClasses, contentStyle]}
+              textStyle={[contentTextClasses, contentTextStyle]}
+            >
+              <ModalContext.Provider value={modal}>
+                <OverlayProvider>{children}</OverlayProvider>
+              </ModalContext.Provider>
+            </View>
+          </View>
+        </SafeAreaView>
+      </FlexView>
+    </BaseModal>
+  );
+});
+
+Modal.displayName = 'Modal';
+
+export default Object.assign(Modal, {
+  Context: ModalContext,
+  Header: ModalHeader,
+  Title: ModalTitle,
+  Body: ModalBody,
+  Footer: ModalFooter,
+});

package/src/components/modal/ModalBody.tsx

@@ -0,0 +1,56 @@
+import React from 'react';
+import { View as BaseView, ScrollView as BaseScrollView } from 'react-native';
+import css from '../../style/css';
+import { getStyles } from '../../utils';
+import useForcedContext from '../../hooks/useForcedContext';
+import StyleSheet from '../../style/StyleSheet';
+import View, { ViewProps } from '../View';
+import ScrollView from '../ScrollView';
+import ModalContext from './ModalContext';
+import { ExtendedTextStyle, StyleProp } from '../../types';
+
+export interface ModalBodyProps extends ViewProps {
+  contentContainerStyle?: StyleProp<ExtendedTextStyle>;
+}
+
+const styles = StyleSheet.create({
+  '.modal-body': css`
+    position: relative;
+    // Enable "flex-grow: 1" so that the body take up as much space as possible
+    // when there should be a fixed height on ".modal-dialog".
+    // Note from bootstrap-rn: Centered modals do not work with this style, but
+    // everything just works fine without this style.
+    // flex: 1 1 auto;
+    padding: $modal-inner-padding;
+  `,
+});
+
+const ModalBody = React.forwardRef<BaseScrollView | BaseView, ModalBodyProps>(
+  (props, ref) => {
+    const { children, style, contentContainerStyle, ...elementProps } = props;
+
+    const { scrollable } = useForcedContext(ModalContext);
+
+    const classes = getStyles(styles, ['.modal-body']);
+
+    const FlexView = scrollable ? ScrollView : View;
+
+    return (
+      <FlexView
+        {...elementProps}
+        // @ts-expect-error We need to fix it in the future.
+        ref={ref}
+        style={scrollable ? style : [classes, style]}
+        contentContainerStyle={
+          scrollable ? [classes, contentContainerStyle] : undefined
+        }
+      >
+        {children}
+      </FlexView>
+    );
+  },
+);
+
+ModalBody.displayName = 'ModalBody';
+
+export default ModalBody;

package/src/components/modal/ModalContext.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+
+type ModalContextType = {
+  scrollable: boolean;
+};
+
+const ModalContext = React.createContext<ModalContextType | null>(null);
+
+ModalContext.displayName = 'ModalContext';
+
+export default ModalContext;

package/src/components/modal/{ModalFooter.js → ModalFooter.tsx}

@@ -1,15 +1,10 @@
 import React from 'react';
-import PropTypes from 'prop-types';
 import StyleSheet from '../../style/StyleSheet';
-import View from '../View';
+import View, { ViewProps, ViewRef } from '../View';
 import css from '../../style/css';
 import { getStyles } from '../../utils';
 
-const propTypes = {
-  children: PropTypes.node.isRequired,
-  // eslint-disable-next-line react/forbid-prop-types
-  style: PropTypes.any,
-};
+export interface ModalFooterProps extends ViewProps {}
 
 const styles = StyleSheet.create({
   '.modal-footer': css`
@@ -28,19 +23,20 @@ const styles = StyleSheet.create({
   `,
 });
 
-const ModalFooter = React.forwardRef((props, ref) => {
-  const { children, style, ...elementProps } = props;
+const ModalFooter = React.forwardRef<ViewRef, ModalFooterProps>(
+  (props, ref) => {
+    const { children, style, ...elementProps } = props;
 
-  const classes = getStyles(styles, ['.modal-footer']);
+    const classes = getStyles(styles, ['.modal-footer']);
 
-  return (
-    <View {...elementProps} ref={ref} style={[classes, style]}>
-      {children}
-    </View>
-  );
-});
+    return (
+      <View {...elementProps} ref={ref} style={[classes, style]}>
+        {children}
+      </View>
+    );
+  },
+);
 
 ModalFooter.displayName = 'ModalFooter';
-ModalFooter.propTypes = propTypes;
 
 export default ModalFooter;

package/src/components/modal/{ModalHeader.js → ModalHeader.tsx}

@@ -1,15 +1,10 @@
 import React from 'react';
-import PropTypes from 'prop-types';
 import StyleSheet from '../../style/StyleSheet';
-import View from '../View';
+import View, { ViewProps, ViewRef } from '../View';
 import css from '../../style/css';
 import { getStyles } from '../../utils';
 
-const propTypes = {
-  children: PropTypes.node.isRequired,
-  // eslint-disable-next-line react/forbid-prop-types
-  style: PropTypes.any,
-};
+export interface ModalHeaderProps extends ViewProps {}
 
 const styles = StyleSheet.create({
   '.modal-header': css`
@@ -27,19 +22,20 @@ const styles = StyleSheet.create({
   `,
 });
 
-const ModalHeader = React.forwardRef((props, ref) => {
-  const { children, style, ...elementProps } = props;
+const ModalHeader = React.forwardRef<ViewRef, ModalHeaderProps>(
+  (props, ref) => {
+    const { children, style, ...elementProps } = props;
 
-  const classes = getStyles(styles, ['.modal-header']);
+    const classes = getStyles(styles, ['.modal-header']);
 
-  return (
-    <View {...elementProps} ref={ref} style={[classes, style]}>
-      {children}
-    </View>
-  );
-});
+    return (
+      <View {...elementProps} ref={ref} style={[classes, style]}>
+        {children}
+      </View>
+    );
+  },
+);
 
 ModalHeader.displayName = 'ModalHeader';
-ModalHeader.propTypes = propTypes;
 
 export default ModalHeader;