react-navigation-header-buttons

react-navigation-header-buttons

This package will help you render buttons in the navigation bar and handle the styling so you don't have to. It tries to mimic the appearance of native navbar buttons and attempts to offer simple and flexible interface for you to interact with. Typed with Flow and ships with TS typings. Supports iOS and Android, web support is experimental.

Demo App

Contains many examples and is available via expo. Sources are in the example folder. I highly recommend you check out both links to get a better idea of the api.

Quick Example

The corresponding code:

import React from 'react';
import { Ionicons } from '@expo/vector-icons';
import { Text } from 'react-native';
import {
  HeaderButtons,
  HeaderButton,
  Item,
  HiddenItem,
  OverflowMenu,
} from 'react-navigation-header-buttons';

const IoniconsHeaderButton = (props) => (
  // the `props` here come from <Item ... />
  // you may access them and pass something else to `HeaderButton` if you like
  <HeaderButton IconComponent={Ionicons} iconSize={23} {...props} />
);

const ReusableItem = ({ onPress }) => <Item title="Edit" onPress={onPress} />;

const ReusableHiddenItem = ({ onPress }) => <HiddenItem title="hidden2" onPress={onPress} />;

export function UsageWithIcons({ navigation }) {
  React.useLayoutEffect(() => {
    navigation.setOptions({
      // in your app, you can extract the arrow function into a separate component
      // to avoid creating a new one every time you update the options
      headerRight: () => (
        <HeaderButtons HeaderButtonComponent={IoniconsHeaderButton}>
          <Item title="search" iconName="ios-search" onPress={() => alert('search')} />
          <ReusableItem onPress={() => alert('Edit')} />
          <OverflowMenu
            style={{ marginHorizontal: 10 }}
            OverflowIcon={({ color }) => <Ionicons name="ios-more" size={23} color={color} />}
          >
            <HiddenItem title="hidden1" onPress={() => alert('hidden1')} />
            <ReusableHiddenItem onPress={() => alert('hidden2')} />
          </OverflowMenu>
        </HeaderButtons>
      ),
    });
  }, [navigation]);

  return <Text style={{ flex: 1, margin: 20 }}>demo!</Text>;
}

Setup

1. yarn add react-navigation-header-buttons

2. Wrap your root component in OverflowMenuProvider, as seen in example's App.tsx. IMPORTANT OverflowMenuProvider must be placed so that it is a child of NavigationContainer, otherwise this library may not receive the correct theme from React Navigation.

Note on theming

Version 7 and later gets colors for Android ripple effect, text and icons from React Navigation's theme, so you will not need to work with colors, with the exception of OverflowIcon as seen above. You can always override colors of text&icons (using color prop) or of the ripple effect on Android (using pressColor prop) as documented below.

Usage

HeaderButtons

Is a wrapper over all the visible header buttons (those can be text-buttons, icon-button, or any custom react elements). The most important prop is HeaderButtonComponent that defines how all icons rendered in children will look. In particular, it allows setting their IconComponent, size and color once so that you don't need to repeat it for each icon-button - but you can override those for each Item if you like.

HeaderButtons accepts:

Item

Renders text, or icon, and has an onPress handler. Take a look at the example to see how to use it.

Item accepts:

Item also accepts other props that you'll typically not need to pass because HeaderButtonComponent already knows them (eg. iconSize) or because they are pulled from the React Navigation's theme object (color).

OverflowMenu

Is the place to define the behavior for overflow button (if there is one). Please note you can render OverflowMenu only by itself too, you do not need to wrap it in HeaderButtons. The most important prop is onPress which defines what kind of overflow menu we should show.

The package exports common handlers you can use, but you can provide your own too (via the onPress prop):

OverflowMenu accepts:

Important note

Children passed to OverflowMenu should be

• either HiddenItems
• or plain function components (no class components) without hooks that return HiddenItem, as seen in the example above.

Anything else will be ignored and will not appear in the overflow menus shown by overflowMenuPressHandlerActionSheet and overflowMenuPressHandlerPopupMenu. Only overflowMenuPressHandlerDropdownMenu supports rendering custom elements, such as <Divider /> (which is exported) or your custom ones.

This limitation may look weird, but it should not really bother you in any way: if you need to have state in your items, lift the state up. The limitation exists because we need to be able to transform declarative React elements into imperative calls (ActionSheetIOS.showActionSheetWithOptions / UIManager.showPopupMenu). If this is a problem for you for some reason, please raise an issue and we'll see what can be done about it.

If OverflowMenu contains no valid child elements, nothing will be rendered at all. (No OverflowIcon, no wrapper.)

function MyComponent({ title }) {
  const [titleFromState, setTitle] = React.useState('from state hook');
  return <HiddenItem title={titleFromState + title} onPress={() => alert('fail')} />;
}

<OverflowMenu OverflowIcon={<Ionicons name="ios-more" size={23} color="blue" />}>
  <MyComponent />
</OverflowMenu>;

const HiddenItemWrapped = () => <HiddenItem title="hidden2" onPress={() => alert('hidden2')} />;
const HiddenItemWrappedTwice = ()=> <HiddenItemWrapped />

<OverflowMenu OverflowIcon={<Ionicons name="ios-more" size={23} color="blue" />}>
  <HiddenItemWrappedTwice />
</OverflowMenu>;

HiddenItem

HiddenItem accepts:

OverflowMenuProvider

This is a React context provider needed for overflowMenuPressHandlerDropdownMenu to work. If you're not using overflowMenuPressHandlerDropdownMenu then you don't need it. By default, you need to wrap your root component with it.

OverflowMenuProvider accepts an optional spaceAboveMenu prop, which can be used to set the distance between the top of the screen and the top of the overflow menu.

HeaderButton

You will typically not use HeaderButton directly. HeaderButton is where all the onPress, title and Icon-related props (color, size) meet to render actual button. See the source if you want to customize it.

Recipes

Customizing the overflow menu

The default handler for overflow menu on iOS is overflowMenuPressHandlerActionSheet.

One of the usual things you may want to do is override the cancel button label on iOS - see example.

Using custom text transforms

Use the buttonStyle prop to set textTransform styles for button titles.

How to integrate in your project

This sections covers how you should use the library in your project. Please note that there are numerous example screens.

1 . Define one file where the styling of header buttons is taken care of.

// MyHeaderButtons.js

import * as React from 'react';
import MaterialIcons from 'react-native-vector-icons/MaterialIcons';
import { HeaderButtons, HeaderButton } from 'react-navigation-header-buttons';

// define IconComponent, color, sizes and OverflowIcon in one place
const MaterialHeaderButton = (props) => (
  <HeaderButton IconComponent={MaterialIcons} iconSize={23} color="blue" {...props} />
);

export const MaterialHeaderButtons = (props) => {
  return <HeaderButtons HeaderButtonComponent={MaterialHeaderButton} {...props} />;
};

2 . Import header buttons from the file defined previously.

// SomeScreen.js
import { MaterialHeaderButtons } from './MyHeaderButtons';
import { Item } from 'react-navigation-header-buttons';

React.useLayoutEffect(() => {
  navigation.setOptions({
    title: 'Demo',
    // use MaterialHeaderButtons with consistent styling across your app
    headerRight: () => (
      <MaterialHeaderButtons>
        <Item title="add" iconName="search" onPress={() => console.warn('add')} />
        <Item title="edit" onPress={() => console.warn('edit')} />
      </MaterialHeaderButtons>
    ),
  });
}, [navigation]);

Known issues

• it appears that when screen title is long, it might interfere with buttons (does not happen when using native stack). This is more probably a react-navigation error, but needs investigation.
• TS typings need improvement, plus I'd like to check their validity via the example project which is using TS. Please get in touch if you wanna help.
• missing styling support for material dropdown menu
• item margins need to be reviewed and polished; don't hesitate to contribute - this should help
• RTL is not tested