One Logo Pool Ball
X
Github
Discord

System

UIKit · IOS API REFERENCE

UIBarButtonItem

class · iOS 2.0+ · SDK 27.1

@MainActor class UIBarButtonItem

Members (69)

static · iOS 26.0+

fixedSpace

TypeScript
static fixedSpace(): Promise<UIBarButtonItem>
Swift declaration
class func fixedSpace() -> Self
static · iOS 14.0+

fixedSpace

TypeScript
static fixedSpace3942(width: number): Promise<UIBarButtonItem>
Swift declaration
class func fixedSpace(_ width: CGFloat) -> Self
static · iOS 14.0+

flexibleSpace

TypeScript
static flexibleSpace(): Promise<UIBarButtonItem>
Swift declaration
class func flexibleSpace() -> Self
method · iOS 5.0+

backButtonBackgroundImage

TypeScript
backButtonBackgroundImage(state: UIControl_State, barMetrics: UIBarMetrics): Promise<(UIImage) | null>
Swift declaration
func backButtonBackgroundImage(for state: UIControl.State, barMetrics: UIBarMetrics) -> UIImage?
method · iOS 5.0+

backButtonBackgroundVerticalPositionAdjustment

TypeScript
backButtonBackgroundVerticalPositionAdjustment(barMetrics: UIBarMetrics): Promise<number>
Swift declaration
func backButtonBackgroundVerticalPositionAdjustment(for barMetrics: UIBarMetrics) -> CGFloat
method · iOS 5.0+

backButtonTitlePositionAdjustment

TypeScript
backButtonTitlePositionAdjustment(barMetrics: UIBarMetrics): Promise<UIOffset>
Swift declaration
func backButtonTitlePositionAdjustment(for barMetrics: UIBarMetrics) -> UIOffset
method · iOS 5.0+

backgroundImage

TypeScript
backgroundImageForBarMetrics(state: UIControl_State, barMetrics: UIBarMetrics): Promise<(UIImage) | null>
Swift declaration
func backgroundImage(for state: UIControl.State, barMetrics: UIBarMetrics) -> UIImage?
method · iOS 6.0+

backgroundImage

TypeScript
backgroundImageForStyleBarMetrics(state: UIControl_State, style: UIBarButtonItem_Style, barMetrics: UIBarMetrics): Promise<(UIImage) | null>
Swift declaration
func backgroundImage(for state: UIControl.State, style: UIBarButtonItem.Style, barMetrics: UIBarMetrics) -> UIImage?
method · iOS 5.0+

backgroundVerticalPositionAdjustment

TypeScript
backgroundVerticalPositionAdjustment(barMetrics: UIBarMetrics): Promise<number>
Swift declaration
func backgroundVerticalPositionAdjustment(for barMetrics: UIBarMetrics) -> CGFloat
method · iOS 16.0+

creatingFixedGroup

TypeScript
creatingFixedGroup(): Promise<UIBarButtonItemGroup>
Swift declaration
func creatingFixedGroup() -> UIBarButtonItemGroup
method · iOS 16.0+

creatingMovableGroup

TypeScript
creatingMovableGroup(customizationIdentifier: string): Promise<UIBarButtonItemGroup>
Swift declaration
func creatingMovableGroup(customizationIdentifier: String) -> UIBarButtonItemGroup
init · iOS 2.0+

init

TypeScript
static init(): Promise<UIBarButtonItem>
Swift declaration
init()
init · iOS 2.0+

init

TypeScript
static initCoder(coder: _Foundation_NSCoder): Promise<(UIBarButtonItem) | null>
Swift declaration
init?(coder: NSCoder)
init · iOS 2.0+

init

TypeScript
static initCustomView(customView: UIView): Promise<UIBarButtonItem>
Swift declaration
convenience init(customView: UIView)
method · iOS 5.0+

setBackButtonBackgroundImage

TypeScript
setBackButtonBackgroundImage(backgroundImage: (UIImage) | null, state: UIControl_State, barMetrics: UIBarMetrics): Promise<void>
Swift declaration
func setBackButtonBackgroundImage(_ backgroundImage: UIImage?, for state: UIControl.State, barMetrics: UIBarMetrics)
method · iOS 5.0+

setBackButtonBackgroundVerticalPositionAdjustment

TypeScript
setBackButtonBackgroundVerticalPositionAdjustment(adjustment: number, barMetrics: UIBarMetrics): Promise<void>
Swift declaration
func setBackButtonBackgroundVerticalPositionAdjustment(_ adjustment: CGFloat, for barMetrics: UIBarMetrics)
method · iOS 5.0+

setBackButtonTitlePositionAdjustment

TypeScript
setBackButtonTitlePositionAdjustment(adjustment: UIOffset, barMetrics: UIBarMetrics): Promise<void>
Swift declaration
func setBackButtonTitlePositionAdjustment(_ adjustment: UIOffset, for barMetrics: UIBarMetrics)
method · iOS 5.0+

setBackgroundImage

TypeScript
setBackgroundImageForBarMetrics(backgroundImage: (UIImage) | null, state: UIControl_State, barMetrics: UIBarMetrics): Promise<void>
Swift declaration
func setBackgroundImage(_ backgroundImage: UIImage?, for state: UIControl.State, barMetrics: UIBarMetrics)
method · iOS 6.0+

setBackgroundImage

TypeScript
setBackgroundImageForStyleBarMetrics(backgroundImage: (UIImage) | null, state: UIControl_State, style: UIBarButtonItem_Style, barMetrics: UIBarMetrics): Promise<void>
Swift declaration
func setBackgroundImage(_ backgroundImage: UIImage?, for state: UIControl.State, style: UIBarButtonItem.Style, barMetrics: UIBarMetrics)
method · iOS 5.0+

setBackgroundVerticalPositionAdjustment

TypeScript
setBackgroundVerticalPositionAdjustment(adjustment: number, barMetrics: UIBarMetrics): Promise<void>
Swift declaration
func setBackgroundVerticalPositionAdjustment(_ adjustment: CGFloat, for barMetrics: UIBarMetrics)
method · iOS 5.0+

setTitlePositionAdjustment

TypeScript
setTitlePositionAdjustment(adjustment: UIOffset, barMetrics: UIBarMetrics): Promise<void>
Swift declaration
func setTitlePositionAdjustment(_ adjustment: UIOffset, for barMetrics: UIBarMetrics)
method · iOS 5.0+

titlePositionAdjustment

TypeScript
titlePositionAdjustment(barMetrics: UIBarMetrics): Promise<UIOffset>
Swift declaration
func titlePositionAdjustment(for barMetrics: UIBarMetrics) -> UIOffset
get · iOS 27.1+

axisBehavior

TypeScript
get axisBehavior(): Promise<UIBarButtonItem_AxisBehavior>
Swift declaration
var axisBehavior: UIBarButtonItem.AxisBehavior { get set }
set · iOS 27.1+

axisBehavior

TypeScript
setAxisBehavior(value: UIBarButtonItem_AxisBehavior): Promise<void>
Swift declaration
var axisBehavior: UIBarButtonItem.AxisBehavior { get set }
get · iOS 9.0+

buttonGroup

TypeScript
get buttonGroup(): Promise<(UIBarButtonItemGroup) | null>
Swift declaration
weak var buttonGroup: UIBarButtonItemGroup? { get }
get · iOS 15.0+

changesSelectionAsPrimaryAction

TypeScript
get changesSelectionAsPrimaryAction(): Promise<boolean>
Swift declaration
var changesSelectionAsPrimaryAction: Bool { get set }
set · iOS 15.0+

changesSelectionAsPrimaryAction

TypeScript
setChangesSelectionAsPrimaryAction(value: boolean): Promise<void>
Swift declaration
var changesSelectionAsPrimaryAction: Bool { get set }
get · iOS 2.0+

customView

TypeScript
get customView(): Promise<(UIView) | null>
Swift declaration
var customView: UIView? { get set }
set · iOS 2.0+

customView

TypeScript
setCustomView(value?: (UIView) | null): Promise<void>
Swift declaration
var customView: UIView? { get set }
get · iOS 16.0+

isHidden

TypeScript
get isHidden(): Promise<boolean>
Swift declaration
var isHidden: Bool { get set }
set · iOS 16.0+

isHidden

TypeScript
setIsHidden(value: boolean): Promise<void>
Swift declaration
var isHidden: Bool { get set }
get · iOS 26.0+

hidesSharedBackground

TypeScript
get hidesSharedBackground(): Promise<boolean>
Swift declaration
var hidesSharedBackground: Bool { get set }
set · iOS 26.0+

hidesSharedBackground

TypeScript
setHidesSharedBackground(value: boolean): Promise<void>
Swift declaration
var hidesSharedBackground: Bool { get set }
get · iOS 26.0+

identifier

TypeScript
get identifier(): Promise<(string) | null>
Swift declaration
var identifier: String? { get set }
set · iOS 26.0+

identifier

TypeScript
setIdentifier(value?: (string) | null): Promise<void>
Swift declaration
var identifier: String? { get set }
get · iOS 14.0+

menu

TypeScript
get menu(): Promise<(UIMenu) | null>
Swift declaration
@NSCopying var menu: UIMenu? { get set }
set · iOS 14.0+

menu

TypeScript
setMenu(value?: (UIMenu) | null): Promise<void>
Swift declaration
@NSCopying var menu: UIMenu? { get set }
get · iOS 16.0+

menuRepresentation

TypeScript
get menuRepresentation(): Promise<(UIMenuElement) | null>
Swift declaration
@NSCopying var menuRepresentation: UIMenuElement? { get set }
set · iOS 16.0+

menuRepresentation

TypeScript
setMenuRepresentation(value?: (UIMenuElement) | null): Promise<void>
Swift declaration
@NSCopying var menuRepresentation: UIMenuElement? { get set }
get · iOS 27.0+

isPaddingRemoved

TypeScript
get isPaddingRemoved(): Promise<boolean>
Swift declaration
var isPaddingRemoved: Bool { get set }
set · iOS 27.0+

isPaddingRemoved

TypeScript
setIsPaddingRemoved(value: boolean): Promise<void>
Swift declaration
var isPaddingRemoved: Bool { get set }
get · iOS 2.0+

possibleTitles

TypeScript
get possibleTitles(): Promise<(Array<string>) | null>
Swift declaration
var possibleTitles: Set<String>? { get set }
set · iOS 2.0+

possibleTitles

TypeScript
setPossibleTitles(value?: (Array<string>) | null): Promise<void>
Swift declaration
var possibleTitles: Set<String>? { get set }
get · iOS 16.0+

preferredMenuElementOrder

TypeScript
get preferredMenuElementOrder(): Promise<UIContextMenuConfiguration_ElementOrder>
Swift declaration
var preferredMenuElementOrder: UIContextMenuConfiguration.ElementOrder { get set }
set · iOS 16.0+

preferredMenuElementOrder

TypeScript
setPreferredMenuElementOrder(value: UIContextMenuConfiguration_ElementOrder): Promise<void>
Swift declaration
var preferredMenuElementOrder: UIContextMenuConfiguration.ElementOrder { get set }
get · iOS 14.0+

primaryAction

TypeScript
get primaryAction(): Promise<(UIAction) | null>
Swift declaration
@NSCopying var primaryAction: UIAction? { get set }
set · iOS 14.0+

primaryAction

TypeScript
setPrimaryAction(value?: (UIAction) | null): Promise<void>
Swift declaration
@NSCopying var primaryAction: UIAction? { get set }
get · iOS 15.0+

isSelected

TypeScript
get isSelected(): Promise<boolean>
Swift declaration
var isSelected: Bool { get set }
set · iOS 15.0+

isSelected

TypeScript
setIsSelected(value: boolean): Promise<void>
Swift declaration
var isSelected: Bool { get set }
get · iOS 26.0+

sharesBackground

TypeScript
get sharesBackground(): Promise<boolean>
Swift declaration
var sharesBackground: Bool { get set }
set · iOS 26.0+

sharesBackground

TypeScript
setSharesBackground(value: boolean): Promise<void>
Swift declaration
var sharesBackground: Bool { get set }
get · iOS 2.0+

style

TypeScript
get style(): Promise<UIBarButtonItem_Style>
Swift declaration
var style: UIBarButtonItem.Style { get set }
set · iOS 2.0+

style

TypeScript
setStyle(value: UIBarButtonItem_Style): Promise<void>
Swift declaration
var style: UIBarButtonItem.Style { get set }
get · iOS 17.0+

isSymbolAnimationEnabled

TypeScript
get isSymbolAnimationEnabled(): Promise<boolean>
Swift declaration
var isSymbolAnimationEnabled: Bool { get set }
set · iOS 17.0+

isSymbolAnimationEnabled

TypeScript
setIsSymbolAnimationEnabled(value: boolean): Promise<void>
Swift declaration
var isSymbolAnimationEnabled: Bool { get set }
get · iOS 2.0+

target

TypeScript
get target(): Promise<(unknown) | null>
Swift declaration
weak var target: AnyObject? { get set }
set · iOS 2.0+

target

TypeScript
setTarget(value?: (unknown) | null): Promise<void>
Swift declaration
weak var target: AnyObject? { get set }
get · iOS 5.0+

tintColor

TypeScript
get tintColor(): Promise<(UIColor) | null>
Swift declaration
var tintColor: UIColor? { get set }
set · iOS 5.0+

tintColor

TypeScript
setTintColor(value?: (UIColor) | null): Promise<void>
Swift declaration
var tintColor: UIColor? { get set }
get · iOS 27.0+

visibilityPriority

TypeScript
get visibilityPriority(): Promise<UIBarButtonItemVisibilityPriority>
Swift declaration
var visibilityPriority: UIBarButtonItemVisibilityPriority { get set }
set · iOS 27.0+

visibilityPriority

TypeScript
setVisibilityPriority(value: UIBarButtonItemVisibilityPriority): Promise<void>
Swift declaration
var visibilityPriority: UIBarButtonItemVisibilityPriority { get set }
get · iOS 2.0+

width

TypeScript
get width(): Promise<number>
Swift declaration
var width: CGFloat { get set }
set · iOS 2.0+

width

TypeScript
setWidth(value: number): Promise<void>
Swift declaration
var width: CGFloat { get set }
init · iOS 14.0+

init

TypeScript
static initSystemItemPrimaryActionMenu(systemItem: UIBarButtonItem_SystemItem, primaryAction?: (UIAction) | null, menu?: (UIMenu) | null): Promise<UIBarButtonItem>
Swift declaration
@MainActor @preconcurrency convenience init(systemItem: UIBarButtonItem.SystemItem, primaryAction: UIAction? = nil, menu: UIMenu? = nil)
method · iOS 16.0+

creatingOptionalGroup

TypeScript
creatingOptionalGroup(customizationIdentifier: string, isInDefaultCustomization?: boolean): Promise<UIBarButtonItemGroup>
Swift declaration
@MainActor @preconcurrency func creatingOptionalGroup(customizationIdentifier: String, isInDefaultCustomization: Bool = true) -> UIBarButtonItemGroup
method · iOS 17.0+

removeAllSymbolEffects

TypeScript
removeAllSymbolEffects(options?: _Symbols_SymbolEffectOptions, animated?: boolean): Promise<void>
Swift declaration
@MainActor @preconcurrency func removeAllSymbolEffects(options: SymbolEffectOptions = .default, animated: Bool = true)
get · iOS 26.0+

badge

TypeScript
get badge(): Promise<(UIBarButtonItem_Badge) | null>
Swift declaration
@MainActor @preconcurrency var badge: UIBarButtonItem.Badge? { get set }
set · iOS 26.0+

badge

TypeScript
setBadge(value?: (UIBarButtonItem_Badge) | null): Promise<void>
Swift declaration
@MainActor @preconcurrency var badge: UIBarButtonItem.Badge? { get set }
init · iOS 14.0+

init

TypeScript
static initTitleImagePrimaryActionMenu(title?: (string) | null, image?: (UIImage) | null, primaryAction?: (UIAction) | null, menu?: (UIMenu) | null): Promise<UIBarButtonItem>
Swift declaration
@MainActor @preconcurrency convenience init(title: String? = nil, image: UIImage? = nil, primaryAction: UIAction? = nil, menu: UIMenu? = nil)

Skipped declarations

13 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

UIBarButtonItem.init(title:image:target:action:menu:)

Objective-C selectors cannot cross the bridge.

UIBarButtonItem.addSymbolEffect(_:options:animated:)

This parameter hides a concrete Swift type.

UIBarButtonItem.addSymbolEffect(_:options:animated:)

This parameter hides a concrete Swift type.

UIBarButtonItem.addSymbolEffect(_:options:animated:)

This parameter hides a concrete Swift type.

UIBarButtonItem.removeSymbolEffect(ofType:options:animated:)

This parameter hides a concrete Swift type.

UIBarButtonItem.removeSymbolEffect(ofType:options:animated:)

This parameter hides a concrete Swift type.

UIBarButtonItem.removeSymbolEffect(ofType:options:animated:)

This parameter hides a concrete Swift type.

UIBarButtonItem.setSymbolImage(_:contentTransition:options:)

This parameter hides a concrete Swift type.

UIBarButtonItem.init(image:style:target:action:)

Objective-C selectors cannot cross the bridge.

UIBarButtonItem.init(image:landscapeImagePhone:style:target:action:)

Objective-C selectors cannot cross the bridge.

UIBarButtonItem.init(title:style:target:action:)

Objective-C selectors cannot cross the bridge.

UIBarButtonItem.init(barButtonSystemItem:target:action:)

Objective-C selectors cannot cross the bridge.

UIBarButtonItem.action

Objective-C selectors cannot cross the bridge.

All UIKit types →