# UserStyleSetting.ColorUserStyleSetting.ColorOption

Artifact: [androidx.wear.watchface:watchface-style](https://developer.android.com/jetpack/androidx/releases/wear-watchface) [View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/style/UserStyleSetting.kt+class:androidx.wear.watchface.style.UserStyleSetting.ColorUserStyleSetting.ColorOption) Added in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

*** ** * ** ***

Kotlin \|[Java](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption "View this page in Java")


```
@RequiresApi(value = 34)
class UserStyleSetting.ColorUserStyleSetting.ColorOption : UserStyleSetting.Option
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.wear.watchface.style.UserStyleSetting.Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option) ||
|   | ↳ | [androidx.wear.watchface.style.UserStyleSetting.ColorUserStyleSetting.ColorOption](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption) |

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Represents choice within a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting`, these must be enumerated up front.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption.Builder` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public properties |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html>` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#colors()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#displayName()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#screenReaderName()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.WatchFaceEditorData?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#watchFaceEditorData()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Inherited functions |
|---|
| From [androidx.wear.watchface.style.UserStyleSetting.Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option) |---|---| | `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `[equals](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option#equals(kotlin.Any))(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `[hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option#hashCode())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `[toString](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option#toString())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | |

| ### Inherited properties |
|---|
| From [androidx.wear.watchface.style.UserStyleSetting.Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option) |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting>` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option#childSettings()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option#id()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | |

## Public properties

### colors

Added in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val colors: @ColorInt List<Int>
```

> [!CAUTION]
> **This property is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

The colors for this option. The colors should be listed in order of decreasing importance. The number of provided colors must be the same for all `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption`s in the list. The number of colors specified is up to the user, but 1 or 3 are common choices.

### displayName

Added in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val displayName: CharSequence
```

> [!CAUTION]
> **This property is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Localized human readable name for the setting, used in the editor style selection UI. This should be short (ideally \< 20 characters).

### screenReaderName

Added in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val screenReaderName: CharSequence
```

> [!CAUTION]
> **This property is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Optional localized human readable name for the setting, used by screen readers. This should be more descriptive than `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#displayName()`. Note prior to android T this is ignored by companion editors.

### watchFaceEditorData

Added in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val watchFaceEditorData: UserStyleSetting.WatchFaceEditorData?
```

> [!CAUTION]
> **This property is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Optional data for an on watch face editor, this will not be sent to the companion and its contents may be used in preference to other fields by an on watch face editor.