/** * Copyright (c) Meta Platforms, Inc. and affiliates. * * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. * * @flow * @format */ import type {AccessibilityRole} from '../../Components/View/ViewAccessibility'; import type { MeasureInWindowOnSuccessCallback, MeasureLayoutOnSuccessCallback, MeasureOnSuccessCallback, } from '../../Renderer/shims/ReactNativeTypes'; import type {ColorValue, ViewStyleProp} from '../../StyleSheet/StyleSheet'; import type {DirectEventHandler} from '../../Types/CodegenTypes'; import StyleSheet from '../../StyleSheet/StyleSheet'; import dismissKeyboard from '../../Utilities/dismissKeyboard'; import StatusBar from '../StatusBar/StatusBar'; import View from '../View/View'; import AndroidDrawerLayoutNativeComponent, { Commands, } from './AndroidDrawerLayoutNativeComponent'; import nullthrows from 'nullthrows'; import * as React from 'react'; const DRAWER_STATES = ['Idle', 'Dragging', 'Settling']; type DrawerStates = 'Idle' | 'Dragging' | 'Settling'; type DrawerSlideEvent = $ReadOnly<{| offset: number, |}>; type Props = $ReadOnly<{| accessibilityRole?: ?AccessibilityRole, /** * Determines whether the keyboard gets dismissed in response to a drag. * - 'none' (the default), drags do not dismiss the keyboard. * - 'on-drag', the keyboard is dismissed when a drag begins. */ keyboardDismissMode?: ?('none' | 'on-drag'), /** * Specifies the background color of the drawer. The default value is white. * If you want to set the opacity of the drawer, use rgba. Example: * * ``` * return ( * * * ); * ``` */ drawerBackgroundColor?: ?ColorValue, /** * Specifies the side of the screen from which the drawer will slide in. */ drawerPosition: ?('left' | 'right'), /** * Specifies the width of the drawer, more precisely the width of the view that be pulled in * from the edge of the window. */ drawerWidth?: ?number, /** * Specifies the lock mode of the drawer. The drawer can be locked in 3 states: * - unlocked (default), meaning that the drawer will respond (open/close) to touch gestures. * - locked-closed, meaning that the drawer will stay closed and not respond to gestures. * - locked-open, meaning that the drawer will stay opened and not respond to gestures. * The drawer may still be opened and closed programmatically (`openDrawer`/`closeDrawer`). */ drawerLockMode?: ?('unlocked' | 'locked-closed' | 'locked-open'), /** * Function called whenever there is an interaction with the navigation view. */ onDrawerSlide?: ?DirectEventHandler, /** * Function called when the drawer state has changed. The drawer can be in 3 states: * - Idle, meaning there is no interaction with the navigation view happening at the time * - Dragging, meaning there is currently an interaction with the navigation view * - Settling, meaning that there was an interaction with the navigation view, and the * navigation view is now finishing its closing or opening animation */ onDrawerStateChanged?: ?(state: DrawerStates) => mixed, /** * Function called whenever the navigation view has been opened. */ onDrawerOpen?: ?() => mixed, /** * Function called whenever the navigation view has been closed. */ onDrawerClose?: ?() => mixed, /** * The navigation view that will be rendered to the side of the screen and can be pulled in. */ renderNavigationView: () => React.MixedElement, /** * Make the drawer take the entire screen and draw the background of the * status bar to allow it to open over the status bar. It will only have an * effect on API 21+. */ statusBarBackgroundColor?: ?ColorValue, children?: React.Node, style?: ?ViewStyleProp, |}>; type State = {| drawerOpened: boolean, |}; /** * React component that wraps the platform `DrawerLayout` (Android only). The * Drawer (typically used for navigation) is rendered with `renderNavigationView` * and direct children are the main view (where your content goes). The navigation * view is initially not visible on the screen, but can be pulled in from the * side of the window specified by the `drawerPosition` prop and its width can * be set by the `drawerWidth` prop. * * Example: * * ``` * render: function() { * var navigationView = ( * * I'm in the Drawer! * * ); * return ( * navigationView}> * * Hello * World! * * * ); * }, * ``` */ class DrawerLayoutAndroid extends React.Component { static get positions(): mixed { console.warn( 'Setting DrawerLayoutAndroid drawerPosition using `DrawerLayoutAndroid.positions` is deprecated. Instead pass the string value "left" or "right"', ); return {Left: 'left', Right: 'right'}; } // $FlowFixMe[missing-local-annot] _nativeRef = React.createRef< React.ElementRef, >(); state: State = { drawerOpened: false, }; render(): React.Node { const { drawerBackgroundColor = 'white', onDrawerStateChanged, renderNavigationView, onDrawerOpen, onDrawerClose, ...props } = this.props; const drawStatusBar = this.props.statusBarBackgroundColor != null; const drawerViewWrapper = ( {renderNavigationView()} {drawStatusBar && } ); const childrenWrapper = ( {drawStatusBar && ( )} {drawStatusBar && ( )} {this.props.children} ); return ( {childrenWrapper} {drawerViewWrapper} ); } /* $FlowFixMe[missing-local-annot] The type annotation(s) required by Flow's * LTI update could not be added via codemod */ _onDrawerSlide = event => { if (this.props.onDrawerSlide) { // $FlowFixMe[unused-promise] this.props.onDrawerSlide(event); } if (this.props.keyboardDismissMode === 'on-drag') { dismissKeyboard(); } }; _onDrawerOpen = () => { this.setState({ drawerOpened: true, }); if (this.props.onDrawerOpen) { this.props.onDrawerOpen(); } }; _onDrawerClose = () => { this.setState({ drawerOpened: false, }); if (this.props.onDrawerClose) { this.props.onDrawerClose(); } }; /* $FlowFixMe[missing-local-annot] The type annotation(s) required by Flow's * LTI update could not be added via codemod */ _onDrawerStateChanged = event => { if (this.props.onDrawerStateChanged) { this.props.onDrawerStateChanged( DRAWER_STATES[event.nativeEvent.drawerState], ); } }; /** * Opens the drawer. */ openDrawer() { Commands.openDrawer(nullthrows(this._nativeRef.current)); } /** * Closes the drawer. */ closeDrawer() { Commands.closeDrawer(nullthrows(this._nativeRef.current)); } /** * Closing and opening example * Note: To access the drawer you have to give it a ref * * Class component: * * render () { * this.openDrawer = () => { * this.refs.DRAWER.openDrawer() * } * this.closeDrawer = () => { * this.refs.DRAWER.closeDrawer() * } * return ( * * {children} * * ) * } * * Function component: * * const drawerRef = useRef() * const openDrawer = () => { * drawerRef.current.openDrawer() * } * const closeDrawer = () => { * drawerRef.current.closeDrawer() * } * return ( * * {children} * * ) */ /** * Native methods */ blur() { nullthrows(this._nativeRef.current).blur(); } focus() { nullthrows(this._nativeRef.current).focus(); } measure(callback: MeasureOnSuccessCallback) { nullthrows(this._nativeRef.current).measure(callback); } measureInWindow(callback: MeasureInWindowOnSuccessCallback) { nullthrows(this._nativeRef.current).measureInWindow(callback); } measureLayout( relativeToNativeNode: number, onSuccess: MeasureLayoutOnSuccessCallback, onFail?: () => void, ) { nullthrows(this._nativeRef.current).measureLayout( relativeToNativeNode, onSuccess, onFail, ); } setNativeProps(nativeProps: Object) { nullthrows(this._nativeRef.current).setNativeProps(nativeProps); } } const styles = StyleSheet.create({ base: { flex: 1, elevation: 16, }, mainSubview: { position: 'absolute', top: 0, left: 0, right: 0, bottom: 0, }, drawerSubview: { position: 'absolute', top: 0, bottom: 0, }, statusBar: { height: StatusBar.currentHeight, }, drawerStatusBar: { position: 'absolute', top: 0, left: 0, right: 0, height: StatusBar.currentHeight, backgroundColor: 'rgba(0, 0, 0, 0.251)', }, }); module.exports = DrawerLayoutAndroid;