---
title: UILexiconEntry
framework: uikit
role: symbol
role_heading: Class
path: uikit/uilexiconentry
---

# UILexiconEntry

A read-only term pair, available within a lexicon object, for a custom keyboard.

## Declaration

```swift
@MainActor class UILexiconEntry
```

## Overview

Overview You can employ a lexicon entry by matching user input against the entry’s userInput value, and then inserting into the current text input object the corresponding documentText value. For example, if the user typed the string “iphone”, the lexicon entry with that exact, case-sensitive string in the userInput property has the string “iPhone” in the corresponding documentText property. In some cases, the documentText string is in a different text script than the userInput string. For information on custom keyboards, which are based on the UIInputViewController class, see Creating a custom keyboard.

## Topics

### Accessing a lexicon entry

- [documentText](uikit/uilexiconentry/documenttext.md)
- [userInput](uikit/uilexiconentry/userinput.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)
- [NSCopying](foundation/nscopying.md)
- [NSObjectProtocol](objectivec/nsobjectprotocol.md)
- [Sendable](swift/sendable.md)

## See Also

### Custom keyboard

- [UITextDocumentProxy](uikit/uitextdocumentproxy.md)
- [UIInputViewAudioFeedback](uikit/uiinputviewaudiofeedback.md)
- [UIInputViewController](uikit/uiinputviewcontroller.md)
- [UILexicon](uikit/uilexicon.md)