How do I hide/show the right button in the Navigation Bar

Question

I need to hide the right button in the Navigation Bar, then unhide it after the user selects some options.

Unfortunately, the following doesn't work:

NO GOOD: self.navigationItem.rightBarButtonItem.hidden = YES;  // FOO CODE

Is there a way?

score 80 · Accepted Answer · answered Apr 07 '11 at 23:57

80

Hide the button by setting the reference to nil, however if you want to restore it later, you'll need to hang onto a copy of it so you can reassign it.

UIBarButtonItem *oldButton = self.navigationItem.rightBarButtonItem;
[oldButton retain];
self.navigationItem.rightBarButtonItem = nil;

//... later
self.navigationItem.rightBarButtonItem = oldButton;
[oldButton release];

Personally, in my apps I make my nav buttons into @properties, so that I can trash & recreate them at will, so something like:

//mycontroller.h
UIBarButtonItem *rightNavButton;
@property (nonatomic, retain) UIBarButtonItem *rightNavButton;

//mycontroller.m
@synthesize rightNavButton;
- (UIBarButtonItem *)rightNavButton {
    if (!rightNavButton) {
        rightNavButton = [[UIBarButtonItem alloc] init];
        //configure the button here
    }
    return rightNavButton;
}

//later, in your code to show/hide the button:
self.navigationItem.rightBarButtonItem = self.rightNavButton;

answered Apr 07 '11 at 23:57

Matt J

961
6
4

Your property method seems like the right solution. Thanks. Question: I'm not clear how I invoke: - (UIBarButtonItem *)rightNavButton { – Lauren Quantrell Apr 08 '11 at 00:29
Sorry, another question. Is there any reason I shouldn't just recreate the button again after setting it to nil, rather than using the two methods you outline? – Lauren Quantrell Apr 08 '11 at 00:36
The rightNavButton function is the "getter" part of the property, which I have manually declared here (the "setter" is handled by synthesize). You invoke it by calling self.rightNavButton. – Matt J Apr 08 '11 at 12:21
You don't have to use the structure that I've used here, but I prefer it. As a matter of habit, anything that I'm going to need to reference at least twice somewhere in my controller logic, I create as a property. This allows me to lazy-load the object on-demand (but not before necessary) in one place. In addition, if this were, for example, a rather large UIImage, or a sound clip, and I encountered a low memory situation, I could set self.rightNavButton = nil to free up the memory, then the object would get regenerated the next time it was requested. – Matt J Apr 08 '11 at 12:24

score 19 · Answer 2 · answered Mar 23 '17 at 12:03

19

For Swift 3

if let button = self.navigationItem.rightBarButtonItem {
                    button.isEnabled = false
                    button.tintColor = UIColor.clear
                }`

answered Mar 23 '17 at 12:03

richc

1,648
5
20
48

score 11 · Answer 3 · answered Oct 15 '13 at 07:40

11

Show:

[self.navigationItem.rightBarButtonItem.customView setAlpha:1.0];

Hide:

[self.navigationItem.rightBarButtonItem.customView setAlpha:0.0];

You can even animate its showing/hiding

[UIView animateWithDuration:0.2 animations:^{
        [self.navigationItem.rightBarButtonItem.customView setAlpha:1.0];

    }];

answered Oct 15 '13 at 07:40

HugoMasterPL

209
3
10

your solution is so perfect :D – Nguyễn Quang Tuấn Aug 30 '19 at 08:54

score 11 · Answer 4 · answered Apr 07 '11 at 23:44

11

Set reference to nil:

current_controller_in_navcontroller.navigationItem.rightBarButtonItem =  nil;

Also be sure to call this in the controller currently shown by the navController, not for the navController itself.

answered Apr 07 '11 at 23:44

Stefan Ticu

2,093
1
12
21

@lauren-quantrell you should Accept the answer if it's correct, it will help the other users reading this post – Stefan Ticu Apr 08 '11 at 01:46

score 7 · Answer 5 · answered Feb 20 '19 at 06:44

If you have only one bar button item in the right side you can use this one,

self.navigationItem.rightBarButtonItem = nil;

Suppose if you have multiple bar button in the right side, for example suppose you have two bar button items(search button and filter button) in the right side of your navigation item. Now the right bar button items are

self.navigationItem.rightBarButtonItems = [searchItem,filterItem]

and you have to hide only search button, you can use like,

self.navigationItem.rightBarButtonItems = [filterItem]

Now what happening is, you can completely hide the search button from the navigation item and the filter item comes in the place of search item

score 5 · Answer 6 · answered Jul 21 '13 at 08:52

Here's Matt's solution updated for Storyboards & ARC. Remember, IBOutlets are __weak by default, so you need to change that to strong for it not to be released too early.

@interface MAGTableViewController () <UITextFieldDelegate>

@property (strong, nonatomic) IBOutlet UIBarButtonItem *rightBarButton;

@end

@implementation MAGTableViewController

- (void)viewDidLoad
{
    [super viewDidLoad];

    [self.navigationItem setRightBarButtonItem:nil];
}

- (IBAction)rightBarButtonItemTapped:(id)sender
{
    [self.view endEditing:YES];
}

- (void)textFieldDidBeginEditing:(UITextField *)textField
{
    [self.navigationItem setRightBarButtonItem:self.rightBarButton];
}

- (void)textFieldDidEndEditing:(UITextField *)textField
{
    [self.navigationItem setRightBarButtonItem:nil];
}

@end

score 4 · Answer 7 · edited May 23 '17 at 12:10

Credit has to go to learner for this answer which the answer is from this question:

hide and show left navigation bar button on demand in iOS-7

This is the answer, which is far more simple.

//hide and reveal bar buttons
-(void) hideAndDisableLeftNavigationItem
{
    [self.navigationItem.leftBarButtonItem setTintColor:[UIColor clearColor]];
    [self.navigationItem.leftBarButtonItem setEnabled:NO];
}

-(void) showAndEnableLeftNavigationItem
{
    [self.navigationItem.leftBarButtonItem setTintColor:[UIColor blueColor]];
    [self.navigationItem.leftBarButtonItem setEnabled:YES];
}

Then you just reference the method where you require it like within an (IBAction) like so:

[self hideAndDisableLeftNavigationItem];//[self showAndEnableLeftNavigationItem]; to show again

I tried all other methods and none worked, even referencing my button as a @property (...) UIBarButtonItem.... and nothing worked until I found this.

score 4 · Answer 8 · answered Sep 02 '16 at 14:28

SWIFT 2.2

In swift 2.2 self.navigationItem does not work. Instead create an outlet of the NavigationItem (I named it below "nav") and use it.

Also the following suggestion did not work for me using Xcode 7.3 and swift 2.2

 nav.leftBarButtonItem?.customView?.hidden = true

So I used the idea of @Matt J above as follows (I have 2 items on the left):

Create outlets for the items in the navigation bar and variables to store them

@IBOutlet weak var settingItem: UIBarButtonItem!
@IBOutlet weak var logoItem: UIBarButtonItem!

var sav_settingItem: UIBarButtonItem = UIBarButtonItem()
var sav_logoItem: UIBarButtonItem = UIBarButtonItem()

Save the items in viewDidLoad()

sav_settingItem = nav.leftBarButtonItems![0]
sav_logoItem = nav.leftBarButtonItems![1]

To HIDE set them to nil

nav.leftBarButtonItem = nil
nav.leftBarButtonItem = nil

To SHOW them

if (nav.leftBarButtonItem == nil) {
    nav.leftBarButtonItem = sav_settingItem
    nav.leftBarButtonItems?.append(sav_logoItem)
    return
}

it works, but it seems like you don't need the outlet. – lenooh Dec 04 '16 at 00:21 — lenooh, Dec 04 '16 at 00:21

score 4 · Answer 9 · answered Mar 05 '17 at 19:21

4

Show:

[self.navigationItem.rightBarButtonItem.customView setHidden:NO];

Hide:

[self.navigationItem.rightBarButtonItem.customView setHidden:YES];

answered Mar 05 '17 at 19:21

Amr Angry

3,711
1
45
37

Doesn't work... – Saad Rehman Jan 14 '22 at 12:01
@SaadRehman sorry i don't even remember which project that i was using this technique :( I am into swift more than Objective C i would like to help if you share a sample on GitHub so we can try something together if you wish – Amr Angry Jan 16 '22 at 17:54
1

Thanks man, I ended up making the button nil to hide it so its fine :) – Saad Rehman Jan 17 '22 at 10:07

score 3 · Answer 10 · answered Oct 28 '15 at 12:08

3

My solution:

self.navigationItem.rightBarButtonItem.customView.hidden=NO;

answered Oct 28 '15 at 12:08

kozla13

1,854
3
23
35

score 2 · Answer 11 · answered Mar 15 '17 at 11:18

Swift 2:

Trick!

Hide:

if let btn = self.tabBarController!.navigationItem.rightBarButtonItem {
        btn.enabled = false
        btn.title = ""
}

Show:

if let btn = self.tabBarController!.navigationItem.rightBarButtonItem {
        btn.enabled = true
        btn.title = "ButtonName"
}

score 2 · Answer 12 · answered May 18 '19 at 11:18

2

You can use below code:

    self.navigationItem.rightBarButtonItem?.image = nil
    self.navigationItem.rightBarButtonItem?.isEnabled = false

answered May 18 '19 at 11:18

Pankaj Jangid

812
9
18

score 2 · Answer 13 · answered Aug 01 '19 at 06:14

2

For swift 5 to hide rightBarButtonItem

self.navigationItem.rightBarButtonItem?.customView?.isHidden = true

answered Aug 01 '19 at 06:14

Hardik Thakkar

15,269
2
94
81

score 1 · Answer 14 · answered Oct 27 '18 at 19:36

In swift 4 I has a trick to show / hide right or left button:

Step 1: Create a IBOutlet button in view controller:

@IBOutlet var navigationItemButton: UIBarButtonItem!

Step 2: Create Hide button function:

func hideNavigationButton() {
    navigationItemButton.isEnabled = false
    navigationItemButton.tintColor = UIColor.clear
}

Step 3: Create Show button function:

func showNavigationButton() {
    navigationItemButton.isEnabled = true
    navigationItemButton.tintColor = UIColor.white
}

Step 4: Just call the functions that you want, use hideNavigationButton() to hide, and showNavigationButton() to show the button.

Regards!

score 0 · Answer 15 · answered Sep 19 '14 at 07:34

0

Show:

//set navigationItem tint color white
self.navigationItem.rightBarButtonItem.tintColor = [UIColor whiteColor];

Hide:

//set navigationItem tint clear white
self.navigationItem.rightBarButtonItem.tintColor = [UIColor clearColor];

answered Sep 19 '14 at 07:34

jebin

101
1
5

While this gives the illusion that it is hidden, it does not disable the functionality of it. I do believe that that is the desired effect. – App Dev Guy Dec 03 '14 at 02:16
1

This is not a proper solution.. if user click on that portion the button action will execute... – Hardik Thakkar Jun 16 '15 at 07:20
I have to agree..this is not an answer. – arvidurs Dec 11 '17 at 18:43

score 0 · Answer 16 · edited Mar 15 '17 at 15:28

0

To hide:

if let topItem = self.navigationController?.navigationBar.topItem {
    topItem.rightBarButtonItem = nil
}

edited Mar 15 '17 at 15:28

Cœur

37,241
25
195
267

answered Feb 23 '17 at 14:38

Stalker

47
4

osexp2000 · Answer 17 · 2017-03-01T14:48:18.767

Assume you can reference the specific bar button as variable xxxButton

(please open Assistant Editor, Control+Drag xxx button to YourViewController class as outlet "xxxButton").

or you can use something like let xxxButton = navigationBar.buttons[1]

Hide xxxButton.customView = UIView() or navigationItem.rightBarButtonItems?.remove(at: (navigationItem.rightBarButtonItems?.index(of:xxxButton)!)!)
Show xxxButton.customView = nil or navigationItem.rightBarButtonItems?.insert(newElement: xxxButton, at:SOME_INDEX)

Hope helpful.

score 0 · Answer 18 · answered Oct 27 '18 at 19:56

0

Set the the title to empty first and after swlwction just set again.

answered Oct 27 '18 at 19:56

Anil Kumar

1,830
15
24

How do I hide/show the right button in the Navigation Bar

18 Answers18

Linked