react-native-popup-menu/README.md at 1fb2f5ea8a6aec09f94b1a5db29843888602ad2b

2.3 KiB

Raw Blame History

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 or slide in from bottom
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

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 MenuContext 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 { MenuContext } from 'react-native-popup-menu';

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

// 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

2.3 KiB Raw Blame History