status-im/react-navigation
2
0
Fork 0
mirror of https://github.com/status-im/react-navigation.git synced 2025-02-25 01:28:16 +00:00
Code Issues Projects Releases Wiki Activity

added drawerBackgroundColor for documentation (#2723)

Browse Source 
* added property inside drawerConfig to backgroundColor (drawerBackgroundColor)

* Adjusting documentation for PR deployment (# 2698)

* add example in the doc
This commit is contained in:
Lucas Padilha 2017-10-11 10:04:22 -03:00 committed by Lorenzo Sciandra
parent 2dca5b2135
commit 09e396002f
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/navigators/DrawerNavigator.md
View File

@ -87,11 +87,12 @@ The route configs object is a mapping from route name to a route config, which t
### DrawerNavigatorConfig ### DrawerNavigatorConfig
- `drawerWidth` - Width of the drawer - `drawerWidth` - Width of the drawer.
- `drawerPosition` - Options are `left` or `right`. Default is `left` position. - `drawerPosition` - Options are `left` or `right`. Default is `left` position.
- `contentComponent` - Component used to render the content of the drawer, for example, navigation items. Receives the `navigation` prop for the drawer. Defaults to `DrawerItems`. For more information, see below. - `contentComponent` - Component used to render the content of the drawer, for example, navigation items. Receives the `navigation` prop for the drawer. Defaults to `DrawerItems`. For more information, see below.
- `contentOptions` - Configure the drawer content, see below. - `contentOptions` - Configure the drawer content, see below.
- `useNativeAnimations` - Enable native animations. Default is `true`. - `useNativeAnimations` - Enable native animations. Default is `true`.
- `drawerBackgroundColor` - Use the Drawer background for some color. The Default is `white`.
#### Example: #### Example:
@ -103,7 +104,8 @@ as you can see in the example below.
{ {
drawerWidth: 200, drawerWidth: 200,
drawerPosition: 'right', drawerPosition: 'right',
contentComponent: props => <ScrollView><DrawerItems {...props} /></ScrollView> contentComponent: props => <ScrollView><DrawerItems {...props} /></ScrollView>,
drawerBackgroundColor: 'transparent'
} }
``` ```