rnc-archive / react-native-drawer-layout

A platform-agnostic drawer layout for react-native
256 stars 63 forks source link
drawer polyfill react-native

react-native-drawer-layout CircleCI styled with prettier

A platform-agnostic drawer layout. It uses a pure JavaScript implementation on every platform to ensure consistency. We try to keep it up to date with the implementation of DrawerLayoutAndroid and add features we consider necessary as well.

Add it to your project

  1. Run npm install react-native-drawer-layout --save
  2. Import the component by using one of these:
    • var DrawerLayout = require('react-native-drawer-layout').default;
    • import DrawerLayout from 'react-native-drawer-layout';
  3. Follow the DrawerLayoutAndroid docs -- the API is the same. Everything that differs is explained below

API

This includes the differences between our implementation and the official one DrawerLayoutAndroid. Every breaking change is (hopefully) hidden behind a feature flag, so that this implementation may also be used as polyfill.

Demo

Examples

To run the demo, please run npm install in the DrawerLayoutExample/ directory and start the demo up from there like any other React Native application.

Support

React Native Version     react-native-drawer-layout Version
>= 11 & < 23 < 1.0
>= 23 >= 1.0 && < 2.0
>= 35 >= 2.0

If you experience any further restrictions with other versions, please let us know.

Restrictions

Release Notes

2.0

Breaking changes

1.0

Breaking changes:

0.3

Breaking changes:

Contribution

Please make sure to run the tests before proposing a PR by running npm test.