Skip to content

udarts/react-native-bottom-toolbar

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

react-native-bottom-toolbar

Bottom toolbar styled as in iOS, implemented in JS, typed with Flow. Highly configurable with text or icons (I recommend react-native-vector-icons) and nested actions that display in ActionSheetIOS (iOS only). You can also render your own components as content.

Breaking changes in 4.0.0: color now applies to both icons and text, size was renamed to iconSize, font was removed, the package now does not have any dependencies, customRenderer was replaced with IconElement prop.

Expo demo

here, code for the demo is in the example folder

Installation & usage

npm i react-native-bottom-toolbar or yarn add react-native-bottom-toolbar

import BottomToolbar from 'react-native-bottom-toolbar'

<BottomToolbar>
  <BottomToolbar.Action
    title="Edit"
    onPress={(index, propsOfThisAction) =>
      console.warn(index + ' ' + JSON.stringify(propsOfThisAction))}
  />
  <BottomToolbar.Action
    title="Copy ULR"
    onPress={(index, propsOfThisAction) =>
      console.warn(index + ' ' + JSON.stringify(propsOfThisAction))}
  />
  <BottomToolbar.Action
    title="Delete"
    onPress={(index, propsOfThisAction) =>
      console.warn(index + ' ' + JSON.stringify(propsOfThisAction))}
  />
</BottomToolbar>

Configuration

The component accepts these props:

type ActionProps = {
  IconComponent?: React.ComponentType<*>,
  title: string,
  iconName?: string,
  disabled?: boolean,
  onPress?: (number, Object) => void,
  color?: string,
  iconSize?: number,
  IconElement?: React.Node,
  actionSheetTitle?: string,
  actionSheetMessage?: string,
};

type NestedActionProps = {
  title: string,
  onPress?: (number, Object) => void,
  style?: 'cancel' | 'destructive',
};

type BottomToolbarProps = {
  IconComponent?: React.ComponentType<*>,
  iconSize: number,
  onPress: (number, Object) => void,
  wrapperStyle?: Object,
  textStyle?: Object,
  buttonStyle?: Object,
  color: string,
  disabledColor: string,
  showIf: boolean,
  children: React.Node,
};

The onPress function can be specified on three different levels: you may pass it as a prop to the component itself (see the first example), you may include it in the BottomToolbar.Action (see the first example), or may include it in the BottomToolbar.NestedAction (see the second example).

The function has to be specified on at least one level. You may combine the levels together - the onPress of a BottomToolbar.NestedAction overrides the onPress of an BottomToolbar.Action, and the onPress of a BottomToolbar.Action overrides the onPress of the component. This gives you a lot of flexibility - you can have one event handler for all actions and nested actions, or you can specify the handlers separately. The onPress function always receives the action / nested action it was triggered from, so you can easily distinguish the event source.

I suggest you pick an approach that works best for a given scenario and stick with it so you keep you code easy to understand.

License

MIT

About

UI Bar in javascript for react native

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%