Popup menu component for React Native
Go to file
Johannes 545441a47a make compatible with react-native-web 2018-04-05 11:03:04 +02:00
.github add issue template 2017-03-14 10:02:25 +01:00
__mocks__ fixed tests 2017-12-21 15:20:53 +01:00
__tests__ make compatible with react-native-web 2018-04-05 11:03:04 +02:00
doc fix #79: Update documentation about option/trigger children 2018-03-12 16:46:28 +01:00
examples rlt test on ios 2017-12-21 15:07:36 +01:00
src make compatible with react-native-web 2018-04-05 11:03:04 +02:00
.babelrc initial version 2016-05-16 16:54:39 +02:00
.eslintignore linting rules for tests 2016-05-17 13:38:25 +02:00
.eslintrc fix linting 2017-10-31 22:52:31 +01:00
.gitignore jasmine reporters 2016-06-07 14:52:13 +02:00
.npmignore updated documentation 2016-11-23 13:33:54 +01:00
Jenkinsfile jenkins dev mail, refined pipeline 2016-06-08 13:50:39 +02:00
LICENSE LICENSE: add title 2017-11-04 12:59:36 +00:00
README.md rtl support 2017-12-20 16:09:05 +01:00
android.demo-popover.gif popover demo gif 2017-12-08 10:52:42 +01:00
android.demo.gif updated demo gif, bigger fonts in demo examples 2017-12-08 11:26:28 +01:00
package.json release 0.12.3 2018-03-12 16:49:15 +01:00
setup-jasmine-env.js jasmine reporters 2016-06-07 14:52:13 +02:00

README.md

react-native-popup-menu

Extensible popup menu component for React Native for Android, iOS and (unofficially) UWP.

Features:

  • Simple to use popup/context menu
  • Multiple modes: animated, not animated, slide in from bottom or popover
  • By default opening and closing animations
  • Optional back button handling
  • Easy styling
  • Customizable on various levels - menu options, positioning, animations
  • Can work as controlled as well as uncontrolled component
  • Different lifecycle hooks
  • RTL layout support
Context Menu, Slide-in Menu Popover
Popup menu demo Popup menu demo

Installation

npm install react-native-popup-menu --save

If you are using older RN versions check our compatibility table.

Basic Usage

Wrap your application inside MenuProvider and then simply use Menu component where you need it. Below you can find a simple example.

For more detailed documentation check API.

// your entry point
import { MenuProvider } from 'react-native-popup-menu';

export const App = () => (
  <MenuProvider>
    <YourApp />
  </MenuProvider>
);

// somewhere in your app
import {
  Menu,
  MenuOptions,
  MenuOption,
  MenuTrigger,
} from 'react-native-popup-menu';

export const YourComponent = () => (
  <View>
    <Text>Hello world!</Text>
    <Menu>
      <MenuTrigger text='Select action' />
      <MenuOptions>
        <MenuOption onSelect={() => alert(`Save`)} text='Save' />
        <MenuOption onSelect={() => alert(`Delete`)} >
          <Text style={{color: 'red'}}>Delete</Text>
        </MenuOption>
        <MenuOption onSelect={() => alert(`Not called`)} disabled={true} text='Disabled' />
      </MenuOptions>
    </Menu>
  </View>
);

Documentation

Contributing

Contributions are welcome! Just open an issues with any idea or pull-request if it is no-brainer. Make sure all tests and linting rules pass.

React Native Compatibility

We keep compatibility on best effort basis.

popup-menu version min RN version
0.9 0.40
0.8 0.38
0.7 0.18