---
title: NSCandidateListTouchBarItem
framework: appkit
role: symbol
role_heading: Class
path: appkit/nscandidatelisttouchbaritem
---

# NSCandidateListTouchBarItem

A bar item that, along with its delegate, provides a list of textual suggestions for the current text view.

## Declaration

```swift
class NSCandidateListTouchBarItem<CandidateType> where CandidateType : AnyObject
```

## Topics

### Providing a client and a delegate

- [client](appkit/nscandidatelisttouchbaritem/client.md)
- [delegate](appkit/nscandidatelisttouchbaritem/delegate.md)
- [NSCandidateListTouchBarItemDelegate](appkit/nscandidatelisttouchbaritemdelegate.md)

### Populating the candidate list

- [setCandidates(_:forSelectedRange:in:)](appkit/nscandidatelisttouchbaritem/setcandidates(_:forselectedrange:in:).md)
- [candidates](appkit/nscandidatelisttouchbaritem/candidates.md)
- [attributedStringForCandidate](appkit/nscandidatelisttouchbaritem/attributedstringforcandidate.md)
- [allowsTextInputContextCandidates](appkit/nscandidatelisttouchbaritem/allowstextinputcontextcandidates.md)

### Handling collapsible behavior

- [allowsCollapsing](appkit/nscandidatelisttouchbaritem/allowscollapsing.md)
- [isCollapsed](appkit/nscandidatelisttouchbaritem/iscollapsed.md)

### Managing candidate list visibility

- [isCandidateListVisible](appkit/nscandidatelisttouchbaritem/iscandidatelistvisible.md)
- [update(withInsertionPointVisibility:)](appkit/nscandidatelisttouchbaritem/update(withinsertionpointvisibility:).md)

### Configuring bar customization

- [customizationLabel](appkit/nscandidatelisttouchbaritem/customizationlabel.md)

## Relationships

### Inherits From

- [NSTouchBarItem](appkit/nstouchbaritem.md)

### Conforms To

- [CVarArg](swift/cvararg.md)
- [CustomDebugStringConvertible](swift/customdebugstringconvertible.md)
- [CustomStringConvertible](swift/customstringconvertible.md)
- [Equatable](swift/equatable.md)
- [Hashable](swift/hashable.md)
- [NSCoding](foundation/nscoding.md)
- [NSObjectProtocol](objectivec/nsobjectprotocol.md)
- [Sendable](swift/sendable.md)
- [SendableMetatype](swift/sendablemetatype.md)

## See Also

### Touch Bar items

- [NSTouchBarItem](appkit/nstouchbaritem.md)
- [NSColorPickerTouchBarItem](appkit/nscolorpickertouchbaritem.md)
- [NSCustomTouchBarItem](appkit/nscustomtouchbaritem.md)
- [NSGroupTouchBarItem](appkit/nsgrouptouchbaritem.md)
- [NSPopoverTouchBarItem](appkit/nspopovertouchbaritem.md)
- [NSSharingServicePickerTouchBarItem](appkit/nssharingservicepickertouchbaritem.md)
- [NSSliderTouchBarItem](appkit/nsslidertouchbaritem.md)
- [NSStepperTouchBarItem](appkit/nssteppertouchbaritem.md)
- [NSUserInterfaceCompressionOptions](appkit/nsuserinterfacecompressionoptions.md)
- [NSButtonTouchBarItem](appkit/nsbuttontouchbaritem.md)
- [NSPickerTouchBarItem](appkit/nspickertouchbaritem.md)
- [NSPickerTouchBarItem.ControlRepresentation](appkit/nspickertouchbaritem/controlrepresentation-swift.enum.md)
- [NSPickerTouchBarItem.SelectionMode](appkit/nspickertouchbaritem/selectionmode-swift.enum.md)