<!--
{
  "availability" : [
    "iOS: 27.2.0 -",
    "iPadOS: 27.2.0 -",
    "macCatalyst: 27.2.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "HomeExtensions",
  "identifier" : "/documentation/HomeExtensions/HomeAccessoryTextFieldSetting",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "HomeExtensions"
    ],
    "preciseIdentifier" : "s:14HomeExtensions0A25AccessoryTextFieldSettingC"
  },
  "title" : "HomeAccessoryTextFieldSetting"
}
-->

# HomeAccessoryTextFieldSetting

A setting that contains a single line of editable text.

```
@propertyWrapper final class HomeAccessoryTextFieldSetting
```

## Overview

The Home app presents this setting as a text field with a Clear button. Your extension receives the new value after a person finishes editing, not after every keystroke.

## Topics

### Creating a text field setting

[`init(id: String, label: HomeAccessorySettingLabel, isEnabled: Bool, defaultValue: String?, currentValue: String?, placeholder: LocalizedStringResource?)`](/documentation/HomeExtensions/HomeAccessoryTextFieldSetting/init(id:label:isEnabled:defaultValue:currentValue:placeholder:))

Creates a text field setting.

### Configuring presentation

[`var label: HomeAccessorySettingLabel`](/documentation/HomeExtensions/HomeAccessoryTextFieldSetting/label)

The label to display for this setting.

[`var isEnabled: Bool`](/documentation/HomeExtensions/HomeAccessoryTextFieldSetting/isEnabled)

A Boolean value that indicates whether people can change the setting.

[`var isHidden: Bool`](/documentation/HomeExtensions/HomeAccessoryTextFieldSetting/isHidden)

A Boolean value that indicates whether the setting is hidden.

### Accessing the value

[`var wrappedValue: String?`](/documentation/HomeExtensions/HomeAccessoryTextFieldSetting/wrappedValue)

The setting’s current text, or its default text if it has none.

[`var projectedValue: HomeAccessoryTextFieldSetting`](/documentation/HomeExtensions/HomeAccessoryTextFieldSetting/projectedValue)

The setting itself, which you access with a dollar sign prefix.

### Instance Properties

[`let id: String`](/documentation/HomeExtensions/HomeAccessoryTextFieldSetting/id)

A unique identifier for the setting.

## Relationships

### Conforms To

[`HomeAccessorySetting`](/documentation/HomeExtensions/HomeAccessorySetting)

[`Identifiable`](/documentation/Swift/Identifiable)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)