Skip to content

Commit

Permalink
Merge pull request #135 from esam091/navbar-documentation
Browse files Browse the repository at this point in the history
Complete missing Config documentations
  • Loading branch information
benkraus committed Jan 5, 2018
2 parents 9f09e36 + 625f420 commit d66b8fc
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions docs/api/navigator-config.md
Expand Up @@ -180,11 +180,35 @@ type Button = {

// ios-only
style: 'plain' | 'default';
systemItem: 'done' | 'cancel' | 'edit' | 'save' | 'add' | 'flexibleSpace' | 'compose' | 'reply' | 'action' | 'organize' | 'bookmarks' | 'search' | 'refresh' | 'stop' | 'camera' | 'trash' | 'play' | 'pause' | 'rewind' | 'fastForward' | 'undo' | 'redo' | 'pageCurl';
systemItem: SystemItem;

// android-only
};

type SystemItem = 'done'
| 'cancel'
| 'edit'
| 'save'
| 'add'
| 'flexibleSpace'
| 'compose'
| 'reply'
| 'action'
| 'organize'
| 'bookmarks'
| 'search'
| 'refresh'
| 'stop'
| 'camera'
| 'trash'
| 'play'
| 'pause'
| 'rewind'
| 'fastForward'
| 'undo'
| 'redo'
| 'pageCurl'

type NavigatorConfigProps = {

// shared
Expand All @@ -196,6 +220,7 @@ type NavigatorConfigProps = {
rightTitle: string;
rightImage: Image;
rightButtons: Array<Button>;
leftButtons: Array<Button>;
screenColor: Color;
hidden: boolean;
backgroundColor: Color;
Expand All @@ -210,12 +235,13 @@ type NavigatorConfigProps = {
titleFontSize: number;
subtitleFontName: string;
subtitleFontSize: number;
leftTitle: string;
leftImage: Image;

// android-only-but-should-share
navIcon: Image;
logo: Image;
textAlign: 'left' | 'center' | 'right';
leftButtons: Array<Button>;

// ios-only
prompt: string;
Expand All @@ -226,6 +252,8 @@ type NavigatorConfigProps = {
isToolbarHidden: boolean;
backIndicatorTransitionMaskImage: Image;
translucent: boolean;
rightSystemItem: SystemItem;
leftSystemItem: SystemItem;

// android-only
statusBarColor: Color;
Expand Down

0 comments on commit d66b8fc

Please sign in to comment.