Skip to main content

Getting Started

Install in existing apps​

Start by installing Zeego:

sh
yarn add zeego
sh
yarn add zeego

Install peer dependencies​

If you're in a monorepo, you should install these in the directory of your native app.

iOS​

sh
yarn add react-native-ios-context-menu
sh
yarn add react-native-ios-context-menu

Android​

sh
yarn add @react-native-menu/menu
sh
yarn add @react-native-menu/menu

Frameworks​

Expo​

Expo users need to use a custom development client, since Zeego uses native code.

After installing Zeego and its peer dependencies, you'll need to rebuild your custom development client:

bash
expo run:ios -d
bash
expo run:ios -d
tip

To install your dev client on your iPhone, make sure it's plugged in to your Mac. If it doesn't show up, you may need to run expo prebuild -p ios, open ios/YourApp.xcworspace in XCode, and make sure your Apple team is properly set up.

After the development client build is complete, you can run your app in dev mode:

bash
expo start --dev-client
bash
expo start --dev-client

If your app is on the App Store, you'll need to deploy a new build too:

eas build --platform ios --autosubmit
eas build --platform ios --autosubmit

Zeego will not work with Expo Go.

If you aren't familiar with how Expo works / what custom development clients are, I recommend using EAS (Expo's hosted build service.) As long as you eas build, it will work.

Solito​

Starter app​

I recommend checking out the Solito + Zeego starter.

Existing Solito apps​

  1. Install the native peer dependencies in your Expo folder (likely apps/expo):
sh
cd apps/expo
yarn add react-native-ios-context-menu @react-native-menu/menu
cd ../..
yarn
sh
cd apps/expo
yarn add react-native-ios-context-menu @react-native-menu/menu
cd ../..
yarn
  1. Follow the Next.js setup.
  2. Follow the Expo steps.

Next.js​

You need to add zeego to your next-transpile-modules in next.config.js.

Vanilla React Native​

Run pod install in your ios folder.