---
title: NSColorList
framework: appkit
role: symbol
role_heading: Class
path: appkit/nscolorlist
---

# NSColorList

An ordered list of color objects, identified by keys.

## Declaration

```swift
class NSColorList
```

## Overview

Overview A color list manages a list of NSColor objects, each of which has an associated name. The NSColorPanel list mode color picker uses instances of NSColorList to represent any lists of colors that come with the system, as well as any lists the user creates. An app can use a color list to manage document-specific color lists.

## Topics

### Creating Lists of Colors

- [init(name:)](appkit/nscolorlist/init(name:).md)
- [init(name:fromFile:)](appkit/nscolorlist/init(name:fromfile:).md)

### Getting Lists of Colors

- [availableColorLists](appkit/nscolorlist/availablecolorlists.md)
- [init(named:)](appkit/nscolorlist/init(named:).md)

### Getting Information About Lists of Colors

- [name](appkit/nscolorlist/name-swift.property.md)
- [NSColorList.Name](appkit/nscolorlist/name-swift.typealias.md)
- [isEditable](appkit/nscolorlist/iseditable.md)

### Managing Colors By Key

- [allKeys](appkit/nscolorlist/allkeys.md)
- [color(withKey:)](appkit/nscolorlist/color(withkey:).md)
- [insertColor(_:key:at:)](appkit/nscolorlist/insertcolor(_:key:at:).md)
- [removeColor(withKey:)](appkit/nscolorlist/removecolor(withkey:).md)
- [setColor(_:forKey:)](appkit/nscolorlist/setcolor(_:forkey:).md)

### Writing and Removing Color List Files

- [write(to:)](appkit/nscolorlist/write(to:).md)
- [removeFile()](appkit/nscolorlist/removefile().md)
- [write(toFile:)](appkit/nscolorlist/write(tofile:).md)

### Notifications

- [didChangeNotification](appkit/nscolorlist/didchangenotification.md)

### Structures

- [NSColorList.DidChangeMessage](appkit/nscolorlist/didchangemessage.md)

### Initializers

- [init(coder:)](appkit/nscolorlist/init(coder:).md)

## Relationships

### Inherits From

- [NSObject](objectivec/nsobject-swift.class.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)
- [NSSecureCoding](foundation/nssecurecoding.md)

## See Also

### Colors

- [NSColor](appkit/nscolor.md)
- [NSColorSpace](appkit/nscolorspace.md)