> ## Documentation Index
> Fetch the complete documentation index at: https://dev.marginnote.com.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# UIBarButtonItem

> Native instance exported as .

Native instance exported as `UIBarButtonItem`.

## Properties

**action** `NativeSelector` *required*

Exported member.

**customView** `UIView | null` *required*

**Type:** `UIView | null`

Exported member.

**enabled** `boolean` *required*

Exported member.

**image** `UIImage | null` *required*

**Type:** `UIImage | null`

Exported member.

**imageInsets** `UIEdgeInsets` *required*

Exported member.

**landscapeImagePhone** `UIImage | null` *required*

**Type:** `UIImage | null`

Exported member.

**landscapeImagePhoneInsets** `UIEdgeInsets` *required*

Exported member.

**possibleTitles** `NSSet | null` *required*

Exported member.

**style** `number` *required*

Exported member.

**tag** `number` *required*

Exported member.

**target** `unknown` *required*

Exported member.

**tintColor** `UIColor | null` *required*

**Type:** `UIColor | null`

Exported member.

**title** `string | null` *required*

Exported member.

**width** `number` *required*

Exported member.

## Methods

### allowsWeakReference()

```typescript
allowsWeakReference(): boolean
```

Exported member.

#### Returns

`boolean`

### autorelease()

```typescript
autorelease(): unknown
```

Exported member.

#### Returns

`unknown`

### backButtonBackgroundImageForStateBarMetrics()

```typescript
backButtonBackgroundImageForStateBarMetrics(_state: number, _barMetrics: number): UIImage | null
```

Exported member.

#### Parameters

**\_state** `number` *required*

**\_barMetrics** `number` *required*

#### Returns

`UIImage | null`

### backButtonBackgroundVerticalPositionAdjustmentForBarMetrics()

```typescript
backButtonBackgroundVerticalPositionAdjustmentForBarMetrics(_barMetrics: number): number
```

Exported member.

#### Parameters

**\_barMetrics** `number` *required*

#### Returns

`number`

### backButtonTitlePositionAdjustmentForBarMetrics()

```typescript
backButtonTitlePositionAdjustmentForBarMetrics(_barMetrics: number): UIOffset
```

Exported member.

#### Parameters

**\_barMetrics** `number` *required*

#### Returns

`UIOffset`

### backgroundImageForStateBarMetrics()

```typescript
backgroundImageForStateBarMetrics(_state: number, _barMetrics: number): UIImage | null
```

Exported member.

#### Parameters

**\_state** `number` *required*

**\_barMetrics** `number` *required*

#### Returns

`UIImage | null`

### backgroundImageForStateStyleBarMetrics()

```typescript
backgroundImageForStateStyleBarMetrics(_state: number, _style: number, _barMetrics: number): UIImage | null
```

Exported member.

#### Parameters

**\_state** `number` *required*

**\_style** `number` *required*

**\_barMetrics** `number` *required*

#### Returns

`UIImage | null`

### backgroundVerticalPositionAdjustmentForBarMetrics()

```typescript
backgroundVerticalPositionAdjustmentForBarMetrics(_barMetrics: number): number
```

Exported member.

#### Parameters

**\_barMetrics** `number` *required*

#### Returns

`number`

### class()

```typescript
class(): NativeClass<NativeObject>
```

Exported member.

#### Returns

`NativeClass<NativeObject>`

### conformsToProtocol()

```typescript
conformsToProtocol(_aProtocol: Protocol | null): boolean
```

Exported member.

#### Parameters

**\_aProtocol** `Protocol | null` *required*

#### Returns

`boolean`

### copy()

```typescript
copy(): unknown
```

Exported member.

#### Returns

`unknown`

### dealloc()

```typescript
dealloc(): void
```

Exported member.

### debugDescription()

```typescript
debugDescription(): string | null
```

Exported member.

#### Returns

`string | null`

### description()

```typescript
description(): string | null
```

Exported member.

#### Returns

`string | null`

### doesNotRecognizeSelector()

```typescript
doesNotRecognizeSelector(_aSelector: string | null): void
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

### finalize()

```typescript
finalize(): void
```

Exported member.

### forwardingTargetForSelector()

```typescript
forwardingTargetForSelector(_aSelector: string | null): unknown
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

#### Returns

`unknown`

### forwardInvocation()

```typescript
forwardInvocation(_anInvocation: NSInvocation | null): void
```

Exported member.

#### Parameters

**\_anInvocation** `NSInvocation | null` *required*

### hash()

```typescript
hash(): number
```

Exported member.

#### Returns

`number`

### isEqual()

```typescript
isEqual(_object: unknown): boolean
```

Exported member.

#### Parameters

**\_object** `unknown` *required*

#### Returns

`boolean`

### isKindOfClass()

```typescript
isKindOfClass(_aClass: NativeClass<NativeObject>): boolean
```

Exported member.

#### Parameters

**\_aClass** `NativeClass\<NativeObject\>` *required*

#### Returns

`boolean`

### isMemberOfClass()

```typescript
isMemberOfClass(_aClass: NativeClass<NativeObject>): boolean
```

Exported member.

#### Parameters

**\_aClass** `NativeClass\<NativeObject\>` *required*

#### Returns

`boolean`

### isProxy()

```typescript
isProxy(): boolean
```

Exported member.

#### Returns

`boolean`

### methodForSelector()

```typescript
methodForSelector(_aSelector: NativeSelector): IMP
```

Exported member.

#### Parameters

**\_aSelector** `NativeSelector` *required*

#### Returns

`IMP`

### methodSignatureForSelector()

```typescript
methodSignatureForSelector(_aSelector: string | null): NSMethodSignature | null
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

#### Returns

`NSMethodSignature | null`

### mutableCopy()

```typescript
mutableCopy(): unknown
```

Exported member.

#### Returns

`unknown`

### performSelector()

```typescript
performSelector(_aSelector: string | null): unknown
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

#### Returns

`unknown`

### performSelectorWithObject()

```typescript
performSelectorWithObject(_aSelector: string | null, _object: unknown): unknown
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

**\_object** `unknown` *required*

#### Returns

`unknown`

### performSelectorWithObjectWithObject()

```typescript
performSelectorWithObjectWithObject(_aSelector: string | null, _object1: unknown, _object2: unknown): unknown
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

**\_object1** `unknown` *required*

**\_object2** `unknown` *required*

#### Returns

`unknown`

### release()

```typescript
release(): void
```

Exported member.

### respondsToSelector()

```typescript
respondsToSelector(_aSelector: NativeSelector): boolean
```

Exported member.

#### Parameters

**\_aSelector** `NativeSelector` *required*

#### Returns

`boolean`

### retain()

```typescript
retain(): unknown
```

Exported member.

#### Returns

`unknown`

### retainCount()

```typescript
retainCount(): number
```

Exported member.

#### Returns

`number`

### retainWeakReference()

```typescript
retainWeakReference(): boolean
```

Exported member.

#### Returns

`boolean`

### self()

```typescript
self(): unknown
```

Exported member.

#### Returns

`unknown`

### setBackButtonBackgroundImageForStateBarMetrics()

```typescript
setBackButtonBackgroundImageForStateBarMetrics(_backgroundImage: UIImage | null, _state: number, _barMetrics: number): void
```

Exported member.

#### Parameters

**\_backgroundImage** `UIImage | null` *required*

**Type:** `UIImage | null`

**\_state** `number` *required*

**\_barMetrics** `number` *required*

### setBackButtonBackgroundVerticalPositionAdjustmentForBarMetrics()

```typescript
setBackButtonBackgroundVerticalPositionAdjustmentForBarMetrics(_adjustment: number, _barMetrics: number): void
```

Exported member.

#### Parameters

**\_adjustment** `number` *required*

**\_barMetrics** `number` *required*

### setBackButtonTitlePositionAdjustmentForBarMetrics()

```typescript
setBackButtonTitlePositionAdjustmentForBarMetrics(_adjustment: UIOffset, _barMetrics: number): void
```

Exported member.

#### Parameters

**\_adjustment** `UIOffset` *required*

**\_barMetrics** `number` *required*

### setBackgroundImageForStateBarMetrics()

```typescript
setBackgroundImageForStateBarMetrics(_backgroundImage: UIImage | null, _state: number, _barMetrics: number): void
```

Exported member.

#### Parameters

**\_backgroundImage** `UIImage | null` *required*

**Type:** `UIImage | null`

**\_state** `number` *required*

**\_barMetrics** `number` *required*

### setBackgroundImageForStateStyleBarMetrics()

```typescript
setBackgroundImageForStateStyleBarMetrics(_backgroundImage: UIImage | null, _state: number, _style: number, _barMetrics: number): void
```

Exported member.

#### Parameters

**\_backgroundImage** `UIImage | null` *required*

**Type:** `UIImage | null`

**\_state** `number` *required*

**\_style** `number` *required*

**\_barMetrics** `number` *required*

### setBackgroundVerticalPositionAdjustmentForBarMetrics()

```typescript
setBackgroundVerticalPositionAdjustmentForBarMetrics(_adjustment: number, _barMetrics: number): void
```

Exported member.

#### Parameters

**\_adjustment** `number` *required*

**\_barMetrics** `number` *required*

### setTitlePositionAdjustmentForBarMetrics()

```typescript
setTitlePositionAdjustmentForBarMetrics(_adjustment: UIOffset, _barMetrics: number): void
```

Exported member.

#### Parameters

**\_adjustment** `UIOffset` *required*

**\_barMetrics** `number` *required*

### setTitleTextAttributesForState()

```typescript
setTitleTextAttributesForState(_attributes: Record<string, unknown> | null, _state: number): void
```

Exported member.

#### Parameters

**\_attributes** `Record\<string, unknown\> | null` *required*

**\_state** `number` *required*

### superclass()

```typescript
superclass(): NativeClass<NativeObject>
```

Exported member.

#### Returns

`NativeClass<NativeObject>`

### titlePositionAdjustmentForBarMetrics()

```typescript
titlePositionAdjustmentForBarMetrics(_barMetrics: number): UIOffset
```

Exported member.

#### Parameters

**\_barMetrics** `number` *required*

#### Returns

`UIOffset`

### titleTextAttributesForState()

```typescript
titleTextAttributesForState(_state: number): Record<string, unknown> | null
```

Exported member.

#### Parameters

**\_state** `number` *required*

#### Returns

`Record<string, unknown> | null`

### zone()

```typescript
zone(): NativePointer | null
```

Exported member.

#### Returns

`NativePointer | null`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.