How do I show/hide a UIBarButtonItem?

Go To StackoverFlow.com

233

I created a toolbar in IB with several buttons. I would like to be able to hide/show one of the buttons depending on the state of the data in the main window.

UIBarButtonItem doesn't have a hidden property, and any examples I've found so far for hiding them involve setting nav bar buttons to nil, which I don't think I want to do here because I may need to show the button again (not to mention that, if I connect my button to an IBOutlet, if I set that to nil I'm not sure how I'd get it back).

2012-04-05 02:04
by Sasha


248

Save your button in a strong outlet (let's call it myButton) and do this to add/remove it:

// Get the reference to the current toolbar buttons
NSMutableArray *toolbarButtons = [self.toolbarItems mutableCopy];

// This is how you remove the button from the toolbar and animate it
[toolbarButtons removeObject:self.myButton];
[self setToolbarItems:toolbarButtons animated:YES];

// This is how you add the button to the toolbar and animate it
if (![toolbarButtons containsObject:self.myButton]) {
    // The following line adds the object to the end of the array.  
    // If you want to add the button somewhere else, use the `insertObject:atIndex:` 
    // method instead of the `addObject` method.
    [toolbarButtons addObject:self.myButton];
    [self setToolbarItems:toolbarButtons animated:YES];
}

Because it is stored in the outlet, you will keep a reference to it even when it isn't on the toolbar.

2012-04-05 03:18
by lnafziger
To make this work for my right button in a Navigation controller I used self.navigationItem.rightBarButtonItems and [self.navigationItem setRightBarButtonItems] instead of toolBarItems and setToolBarItems - MindSpiker 2012-11-12 19:11
@MindSpiker: Yes, he same technique works for the buttons on a navigation bar as well - lnafziger 2012-11-12 19:43
do i have to nil myButton in dealloc - Van Du Tran 2013-10-05 14:27
@VanDuTran: No, see: http://stackoverflow.com/q/7906804/93782 - lnafziger 2013-10-06 03:53
Or Apple could've just added .hidden property. -_ - GeneCode 2016-02-22 11:29


196

I know this answer is late for this question. However, it might help if anybody else faces a similar situation.

In iOS 7, to hide a bar button item, we can use the following two techniques :-

  • use SetTitleTextAttributes :- This works great on bar button items like "Done", "Save" etc. However, it does not work on items like Add, Trash symbol etc.(atleast not for me) since they are not texts.
  • use TintColor :- If I have a bar button item called "deleteButton" :-

To hide the button, I used the following code:-

[self.deleteButton setEnabled:NO]; 
[self.deleteButton setTintColor: [UIColor clearColor]];

To show the button again I used the following code:-

[self.deleteButton setEnabled:YES];
[self.deleteButton setTintColor:nil];
2014-07-09 00:48
by Max
[self.navigationItem.rightBarButtonItem setEnabled:NO]; [self.navigationItem.rightBarButtonItem setTintColor: [UIColor clearColor]] - Leon 2015-07-02 21:02
For Swift: deleteButton.enabled = false; deleteButton.tintColor = UIColor.clearColor() to disable and hide, and deleteButton.enabled = true; deleteButton.tintColor = nil to re-enable and show as normal - Unixmonkey 2015-07-08 22:04
I like that this approach lets me put the logic for whether or not to display the UIBarButton inside that class. The reason it only works with one button is not immediately obvious--it's because if you hide a button this way it will still take up space, so you might have an empty gap if you have multiple buttons - SimplGy 2016-11-15 19:54
Your first approach was perfect for me. I set UIColor.clear for UIControlState.disabled and can show/hide the button with setEnabled. Of course as you stated, this works only for text buttons - fl034 2018-09-11 15:18
If l long press on it until it pops up in a big image (probably for accessibility) then even with isEnabled set to false it still works - Daniel Springer 2018-12-30 23:31


66

Here's a simple approach:

hide:  barbuttonItem.width = 0.01;
show:  barbuttonItem.width = 0; //(0 defaults to normal button width, which is the width of the text)

I just ran it on my retina iPad, and .01 is small enough for it to not show up.

2012-08-25 19:31
by Drew Rosenberg
Of all the solutions, this one was quick, dirty, and effective. I also added barbuttItem.enabled = NO; since I could still get the button to fire if I hit it enough - Stickley 2012-09-26 20:52
Doesn't work for me. I thought it was because I was using an Add button with the '+' image, but I tried a Custom button with the text "New" instead and it still doesn't vanish. The enablement changes so I know my code is being executed. Any ideas? Note that this button is created in a storyboard and has a segue so I dont want to change to a programmatic button instea - Rhubarb 2012-10-01 16:56
It doesn't seem to work in a navigation controller toolbar, but it does for other toolbars - Drew Rosenberg 2012-10-02 19:23
It hides it but it still responds to taps. For me it acts like an invisible button - Tibidabo 2013-07-24 13:59
Works also in iOS7 - Simo A. 2013-11-17 23:43
It is simply not working on my navigation controller toolba - Tom 2014-02-18 09:53
doesn't seem to work in ios 8 xcode 6. - vboombatz 2015-05-28 22:49
doesn't seem to work in ios 9 xcode 7.3. - jose920405 2016-06-02 20:07
If you have set global tint color by using this line self.window?.tintColor = APP_PRIMARY_COLOR in appdelegate, then this will not wor - Mehul Thakkar 2017-06-19 05:46


56

It is possible to hide a button in place without changing its width or removing it from the bar. If you set the style to plain, remove the title, and disable the button, it will disappear. To restore it, just reverse your changes.

-(void)toggleBarButton:(bool)show
{
    if (show) {
        btn.style = UIBarButtonItemStyleBordered;
        btn.enabled = true;
        btn.title = @"MyTitle";
    } else {
        btn.style = UIBarButtonItemStylePlain;
        btn.enabled = false;
        btn.title = nil;
    }
}
2013-05-03 17:22
by Eli Burke
This worked for me by simply setting btn.title = nil. I'm also setting enabled = NO, just in case.. - Pork 'n' Bunny 2013-08-07 15:18
Setting the buttonItem.title to nil didn't work for me in iOS7. The button did not reappear when setting it back. However what did work was setting buttonItem.title=@" " - Mark Knopper 2013-10-01 13:23


41

Below is my solution though i was looking it for Navigation Bar.

navBar.topItem.rightBarButtonItem = nil;

Here "navBar" is a IBOutlet to the NavigationBar in the view in XIB Here i wanted to hide the button or show it based on some condition. So i m testing for the condition in "If" and if true i am setting the button to nil in viewDidLoad method of the target view.

This may not be relevant to your problem exactly but something similar incase if you want to hide buttons on NavigationBar

2013-09-17 11:50
by vishal dharankar
If you want to later set rightBarButtonItem again, make sure the button item is stored in a strong IBOutlet so that it's not released when you take it off the navigation bar - Nate 2016-10-22 12:01


23

For Swift 3 and Swift 4 you can do this to hide the UIBarButtomItem:

self.deleteButton.isEnabled = false
self.deleteButton.tintColor = UIColor.clear

And to show the UIBarButtonItem:

self.deleteButton.isEnabled = true
self.deleteButton.tintColor = UIColor.blue

On the tintColor you must have to specify the origin color you are using for the UIBarButtomItem

2016-12-02 19:50
by pableiros
But this will still take space for this button - Makalele 2017-12-19 10:55


21

I am currently running OS X Yosemite Developer Preview 7 and Xcode 6 beta 6 targeting iOS 7.1 and following solution works fine for me:

  • Create outlet for UINavigationItemand UIBarButtonItems
  • Run following code to remove

    [self.navItem setRightBarButtonItem:nil];
    [self.navItem setLeftBarButtonItem:nil];
    
  • Run following codes to add buttons again

    [self.navItem setRightBarButtonItem:deleteItem];
    [self.navItem setLeftBarButtonItem:addItem];
    
2014-09-23 01:53
by Olcay Ertaş
Thanks, this is the best method I've found as well. Just make sure your references to your buttons are strong - jyoung 2015-07-27 03:50
Also, keep in mind that this works only if you have just one button there. The example will remove ALL buttons on that side - lnafziger 2015-11-14 16:54
@jyoung This worked for me, but why does it matter if the reference is strong? I didn't try the other way, but usually don't set it that way since it's not the default - Robert 2015-11-17 01:52
@Robert You want to use the object at a later time, so you need to make sure the object doesn't get garbage collected when you set it to nil. If nothing else was retaining the object when you told the bar button item it's ok to get rid of it, it's reference count would be 0 and it would be garbage collected - jyoung 2015-11-18 16:27


14

I used IBOutlets in my project. So my solution was:

@IBOutlet weak var addBarButton: UIBarButtonItem!

addBarButton.enabled = false
addBarButton.tintColor = UIColor.clearColor()

And when you'll need to show this bar again, just set reversed properties.

In Swift 3 instead enable use isEnable property.

2016-06-19 13:58
by Den


12

self.dismissButton.customView = [[UIView alloc] initWithFrame:CGRectMake(0, 0, 0, 0)];

2012-12-12 09:02
by Dmitry Semenyuk


12

iOS 8. UIBarButtonItem with custom image. Tried many different ways, most of them were not helping. Max's solution, thesetTintColor was not changing to any color. I figured out this one myself, thought it will be of use to some one.

For Hiding:

[self.navigationItem.rightBarButtonItem setEnabled:NO];
[self.navigationItem.rightBarButtonItem setImage:nil];

For Showing:

[self.navigationItem.rightBarButtonItem setEnabled:YES];
[self.navigationItem.rightBarButtonItem setImage:image];
2015-07-03 10:46
by Rinto Rapheal


9

Try in Swift, don't update the tintColor if you have some design for your UIBarButtonItem like font size in AppDelegate, it will totally change the appearance of your button when showing up.

In case of a text button, changing title can let your button 'disappear'.

if WANT_TO_SHOW {
    myBarButtonItem.enabled = true
    myBarButtonItem.title = "BUTTON_NAME"
}else{
    myBarButtonItem.enabled = false
    myBarButtonItem.title = ""
}
2015-04-15 15:09
by Jeffrey Neo


6

@IBDesignable class AttributedBarButtonItem: UIBarButtonItem {

    var isHidden: Bool = false {

        didSet {

            isEnabled = !isHidden
            tintColor = isHidden ? UIColor.clear : UIColor.black
        }
    }
}

And now simply change isHidden property.

2017-05-10 11:26
by Bartłomiej Semańczyk


6

I discovered another wrinkle in the tintColor and isEnabled approach suggested by Max and others - when VoiceOver is enabled for accessibility and the button is logically hidden, the accessibility cursor will still focus on the bar button, and state that it is "dimmed" (i.e. because isEnabled is set to false). The approach in the accepted answer doesn't suffer from this side-effect, but another work around I found was to set isAccessibilityElement to false when "hiding" the button:

deleteButton.tintColor = UIColor.clear
deleteButton.isEnabled = false
deleteButton.isAccessibilityElement = false

And then setting isAccessibilityElement back to true when "showing" the button:

deleteButton.tintColor = UIColor.blue
deleteButton.isEnabled = true
deleteButton.isAccessibilityElement = true

Having the bar button item still take up space was not an issue in my case, since we were hiding/showing the left-most of right bar button items.

2017-12-19 23:00
by Evan Kirkwood


5

Improving From @lnafziger answer

Save your Barbuttons in a strong outlet and do this to hide/show it:

-(void) hideBarButtonItem :(UIBarButtonItem *)myButton {
    // Get the reference to the current toolbar buttons
    NSMutableArray *navBarBtns = [self.navigationItem.rightBarButtonItems mutableCopy];

    // This is how you remove the button from the toolbar and animate it
    [navBarBtns removeObject:myButton];
    [self.navigationItem setRightBarButtonItems:navBarBtns animated:YES];
}


-(void) showBarButtonItem :(UIBarButtonItem *)myButton {
    // Get the reference to the current toolbar buttons
    NSMutableArray *navBarBtns = [self.navigationItem.rightBarButtonItems mutableCopy];

    // This is how you add the button to the toolbar and animate it
    if (![navBarBtns containsObject:myButton]) {
        [navBarBtns addObject:myButton];
        [self.navigationItem setRightBarButtonItems:navBarBtns animated:YES];
    }
}

When ever required use below Function..

[self showBarButtonItem:self.rightBarBtn1];
[self hideBarButtonItem:self.rightBarBtn1];
2015-11-20 11:16
by umakanta


4

There is no way to "hide" a UIBarButtonItem you must remove it from the superView and add it back when you want to display it again.

2012-04-05 02:29
by Kyle Richter
This is actually not true - the method described by Max works well - northernman 2014-10-21 03:14
nothernman - Max is not actually correct. He isn't actually hiding the button in the way most people would define "hiding". He is simply making it not visible and disabling user interaction. The button is still there and takes up space. It comes down to how you want to define "hide", I believe the spirit of the original question was wanting to actually remove/add it, not just make it invisible - Michael Peterson 2015-08-07 19:52


4

This is long way down the answer list, but just in case somebody wants an easy copy and paste for the swift solution, here it is

func hideToolbarItem(button: UIBarButtonItem, withToolbar toolbar: UIToolbar) {
    var toolbarButtons: [UIBarButtonItem] = toolbar.items!
    toolbarButtons.removeAtIndex(toolbarButtons.indexOf(button)!)
    toolbar.setItems(toolbarButtons, animated: true)
}

func showToolbarItem(button: UIBarButtonItem, inToolbar toolbar: UIToolbar, atIndex index: Int) {
    var toolbarButtons: [UIBarButtonItem] = toolbar.items!
    if !toolbarButtons.contains(button) {
        toolbarButtons.insert(button, atIndex: index)
        toolbar.setItems(toolbarButtons, animated:true);
    }
}
2016-01-30 22:20
by maninvan
Not bad but you must give a UINavigationItem as parameter and not UIToolbar because he asks to hide a UIBarButtonItem. I modified your function to this:

func hideToolbarItem(button: UIBarButtonItem, withToolbar toolbar: UINavigationItem) {
    var toolbarButtons: [UIBarButtonItem] = toolbar.rightBarButtonItems!
    toolbarButtons.removeAtIndex(toolbarButtons.indexOf(button)!)
    toolbar.setRightBarButtonItems(toolbarButtons, animated: true)
}

and that works grea - Kingalione 2016-04-08 14:09



3

One way to do it is use the initWithCustomView:(UIView *) property of when allocating the UIBarButtonItem. Subclass for UIView will have hide/unhide property.

For example:

1. Have a UIButton which you want to hide/unhide.

2. Make the UIButtonas the custom view. Like :

UIButton*myButton=[UIButton buttonWithType:UIButtonTypeRoundedRect];//your button

UIBarButtonItem*yourBarButton=[[UIBarButtonItem alloc] initWithCustomView:myButton];

3. You can hide/unhide the myButton you've created. [myButton setHidden:YES];

2012-04-05 03:26
by iNoob
However, it won't close the gap between the other buttons: When it is "hidden" there will be an empty area on the toolbar - lnafziger 2012-04-05 03:29
@lnafziger Yes that is true, but i didn't read the OP mention about closing the gap between the buttons, but it is a good point to note though - iNoob 2012-04-05 03:32
Thanks, your answer is useful too, but I think that most people when they want to hide a button on a toolbar want it to look like it isn't there at all (without the blank area). If it's the left or right one it wouldn't really matter though - lnafziger 2012-04-05 03:36
Good points, iNoob and Inafziger - I didn't mention it either way but yes, I would prefer that there not be a blank spot - Sasha 2012-04-06 01:33


2

Setting the text color to a clear color when the bar button item is disabled is probably a cleaner option. There's no weirdness that you have to explain in a comment. Also you don't destroy the button so you still keep any associated storyboard segues.

[self.navigationItem.rightBarButtonItem setTitleTextAttributes:@{NSForegroundColorAttributeName:[UIColor clearColor]}
                                                      forState:UIControlStateDisabled];

Then when ever you want the bar button item hidden, you can just do:

self.navigationItem.rightBarButton.enabled = NO;

It's lame there's no hidden property but this offers the same result.

2014-04-04 17:28
by puppybits
I had a button inside the rightBarButtonItem. So I set its enabled to NO and changed its image on disabled state to nil. Worked like a charm...Thank - Skywalker 2015-12-10 13:55
excellent idea, however setting the image to null didnt work for me, i had to put a little transparent square of 20x20 as the imag - Lena Bru 2015-12-23 15:03
this is brills.... works great for text/custom button - IMFletcher 2016-04-14 01:56


2

In case the UIBarButtonItem has an image instead of the text in it you can do this to hide it: navigationBar.topItem.rightBarButtonItem.customView.alpha = 0.0;

2014-06-10 19:58
by Artem Goryaev


2

Some helper methods I thought I'd share based upon lnafziger's accepted answer as I have multiple toolbars and multiple buttons in each:

-(void) hideToolbarItem:(UIBarButtonItem*) button inToolbar:(UIToolbar*) toolbar{
    NSMutableArray *toolbarButtons = [toolbar.items mutableCopy];
    [toolbarButtons removeObject:button];
    [toolbar setItems:toolbarButtons animated:NO];
}

-(void) showToolbarItem:(UIBarButtonItem*) button inToolbar:(UIToolbar*) toolbar atIndex:(int) index{
    NSMutableArray *toolbarButtons = [toolbar.items mutableCopy];
    if (![toolbarButtons containsObject:button]){
        [toolbarButtons insertObject:button atIndex:index];
        [self setToolbarItems:toolbarButtons animated:YES];
    }
}
2015-11-13 01:18
by Guy Lowe


2

You can easily get the view and hide it this way

let view: UIView = barButtonItem.valueForKey("view") as! UIView
view.hidden = true
2016-05-31 15:49
by Titouan de Bailleul


2

If you are using Swift 3

if (ShowCondition){
   self.navigationItem.rightBarButtonItem = self.addAsset_btn 
 } 
else {
   self.navigationItem.rightBarButtonItem = nil
 }
2016-10-25 07:14
by Museer Ahamad Ansari


1

Complementing Eli Burke`s response, if your UIBarButtonItemhas a background image instead of a title, you can use the code:

-(void)toggleLogoutButton:(bool)show{
    if (show) {
        self.tabButton.style = UIBarButtonItemStyleBordered;
        self.tabButton.enabled = true;
        UIImage* imageMap = [UIImage imageNamed:@"btn_img.png"];
        [((UIButton *)[self.tabButton customView]) setBackgroundImage:imageMap forState:UIControlStateNormal];
    } else {
        self.tabButton.style = UIBarButtonItemStylePlain;
        self.tabButton.enabled = false;
        [((UIButton *)[self.tabButton customView]) setBackgroundImage:nil forState:UIControlStateNormal];
    }
}
2013-09-16 17:57
by Renato Lochetti


1

For Swift version, here is the code:

For UINavigationBar:

self.navigationItem.rightBarButtonItem = nil

self.navigationItem.leftBarButtonItem = nil
2015-12-01 09:16
by Sohil R. Memon


1

Just Set barButton.customView = UIView() and see the Trick

2017-08-04 07:40
by jeff ayan
What this answer does do, is allow all the flexible sizing to work. It's actually a super efficient answer. Probably coupled with an extension it would be perfect - Adrian_H 2018-09-12 14:20


1

Here is an extension that will handle this.

extension UIBarButtonItem {

    var isHidden: Bool {
        get {
            return tintColor == .clear
        }
        set {
            tintColor = newValue ? .clear : .white //or whatever color you want
            isEnabled = !newValue
            isAccessibilityElement = !newValue
        }
    }

}

USAGE:

myBarButtonItem.isHidden = true
2018-07-08 00:09
by Harris


0

You need to manipulate the toolbar.items array.

Here is some code I use to hide and display a Done button. If your button is on the extreme edge of the toolbar or in-between other buttons your other buttons will move, so if you want your button to just disappear then place your button as the last button towards the centre. I animate the button move for effect, I quite like it.

-(void)initLibraryToolbar {

    libraryToolbarDocumentManagementEnabled = [NSMutableArray   arrayWithCapacity:self.libraryToolbar.items.count];
    libraryToolbarDocumentManagementDisabled = [NSMutableArray arrayWithCapacity:self.libraryToolbar.items.count];
    [libraryToolbarDocumentManagementEnabled addObjectsFromArray:self.libraryToolbar.items];
    [libraryToolbarDocumentManagementDisabled addObjectsFromArray:self.libraryToolbar.items];
    trashCan = [libraryToolbarDocumentManagementDisabled objectAtIndex:3];
    mail = [libraryToolbarDocumentManagementDisabled objectAtIndex:5];
    [libraryToolbarDocumentManagementDisabled removeObjectAtIndex:1];
    trashCan.enabled = NO;
    mail.enabled = NO;
    [self.libraryToolbar setItems:libraryToolbarDocumentManagementDisabled animated:NO];

}

so now can use the following code to show your button

[self.libraryToolbar setItems:libraryToolbarDocumentManagementEnabled animated:YES];
trashCan.enabled = YES;
mail.enabled = YES; 

or to hide your button

[self.libraryToolbar setItems:libraryToolbarDocumentManagementDisabled animated:YES];
trashCan.enabled = NO;
mail.enabled = NO;
2012-04-05 02:47
by Graham


0

In IB if you leave the button's title blank it will not appear (never initialized?). I do this often during development during UI updates if I want a bar button item to temp disappear for a build without deleting it and trashing all its outlet references.

This does not have the same effect during runtime, setting the button's title to nil will not cause it the whole button to disappear. Sorry doesn't really answer your question, but may be useful to some.

Edit: This trick only works if the button's style is set to plain

2013-01-10 21:00
by pretzels1337


0

I'll add my solution here as I couldn't find it mentioned here yet. I have a dynamic button whose image depends on the state of one control. The most simple solution for me was to set the image to nil if the control was not present. The image was updated each time the control updated and thus, this was optimal for me. Just to be sure I also set the enabled to NO.

Setting the width to a minimal value did not work on iOS 7.

2013-11-10 20:36
by mkko


0

With credit to @lnafziger, @MindSpiker, @vishal, et. al,

The simplest one liner that I arrived at for a single right (or left) bar button is:

self.navigationItem.rightBarButtonItem = <#StateExpression#>
    ? <#StrongPropertyButton#> : nil;

As in:

@interface MyClass()

@property (strong, nonatomic) IBOutlet UIBarButtonItem *<#StrongPropertyButton#>;

@end

@implementation

- (void) updateState
{
    self.navigationItem.rightBarButtonItem = <#StateExpression#>
        ? <#StrongPropertyButton#> : nil;
}

@end

I tested this and it works for me (with the strong bar button item wired via IB).

2014-02-09 17:23
by Chris Conover
This will work if you only have one button, but if you have multiple buttons you will need to use a method more along the lines of my answer - lnafziger 2014-04-26 16:20


0

Subclass UIBarButtonItem. Make sure the button in Interface Builder is set to HidableBarButtonItem. Make an outlet from the button to the view controller. From the view controller you can then hide/show the button by calling setHidden:

HidableBarButtonItem.h

#import <UIKit/UIKit.h>

@interface HidableBarButtonItem : UIBarButtonItem

@property (nonatomic) BOOL hidden;

@end

HidableBarButtonItem.m

#import "HidableBarButtonItem.h"

@implementation HidableBarButtonItem

- (void)setHidden:(BOOL const)hidden {
    _hidden = hidden;

    self.enabled = hidden ? YES : NO;
    self.tintColor = hidden ? [UIApplication sharedApplication].keyWindow.tintColor : [UIColor clearColor];
}

@end
2014-08-28 07:44
by Pétur Ingi Egilsson


0

I worked with xib and with UIToolbar. BarButtonItem was created in xib file. I created IBOutlet for BarButtonItem. And I used this code to hide my BarButtonItem

 self.myBarButtonItem.enabled = NO;
 self.myBarButtonItem.title =  nil;

this helped me.

2015-01-20 13:20
by Malder


0

You can use text attributes to hide a bar button:

barButton.enabled = false
barButton.setTitleTextAttributes([NSForegroundColorAttributeName : UIColor.clearColor()], forState: .Normal)

Also see my solution with UIBarButtonItem extension for the similar question: Make a UIBarButtonItem disapear using swift IOS

2015-08-21 11:43
by iUrii


-5

My solution is set bounds.width to 0 for what you have inside UIBarButtonItem (I used this approach with UIButton and UISearchBar):

Hide:

self.btnXXX.bounds = CGRectMake(0,0,0,0);

Show:

self.btnXXX.bounds = CGRectMake(0,0,40,30); // <-- put your sizes here
2012-05-25 03:08
by Mike Keskinov
It actually worked for iOS 6 and below, but not now - Mike Keskinov 2013-09-30 17:01
Ads